<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_class_boption">
<title>Boption Class Reference</title>
<indexterm><primary>Boption</primary></indexterm>
<para>

<para>A class for a command line input option. </para>
 
</para>
<para>
<computeroutput>#include &lt;options.h&gt;</computeroutput>
</para>
<simplesect>
    <title>Public Member Functions    </title>
        <itemizedlist>
            <listitem><para><link linkend="_class_boption_1a0147d92142af524514c7ca812d8b97c1">Boption</link> (char *arg, char *arg1, const char *<link linkend="_radonrecon_8cpp_1a4de0ad4c7190962494815c0fa7f948df">use</link>[])</para>
</listitem>
            <listitem><para>int <link linkend="_class_boption_1a935418941b27186b4bb0eac780156fee">errors</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> <link linkend="_class_boption_1a99ceaf355a40371350fb0fbcdefa660c">filename</link> ()</para>
</listitem>
            <listitem><para><link linkend="_utilities_8h_1ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</link> <link linkend="_class_boption_1adfc7980903c5ff7f725cd60e80f2f515">datatype</link> ()</para>
</listitem>
            <listitem><para>long <link linkend="_class_boption_1ac5fececea4406b04ec9fcc9e6d5aebc4">integer</link> ()</para>
</listitem>
            <listitem><para>double <link linkend="_class_boption_1a06c002f5f4d9c62e95e06a54fecfdd45">real</link> ()</para>
</listitem>
            <listitem><para>template&lt;typename T1 , typename T2 &gt; </para><para>long <link linkend="_class_boption_1a1aac6da05d8db1ed5f86e5022ca89b86">values</link> (T1 &amp;v1, T2 &amp;v2)</para>
</listitem>
            <listitem><para>template&lt;typename T1 , typename T2 , typename T3 &gt; </para><para>long <link linkend="_class_boption_1a1dd95807e049ae318d24a013e80974fb">values</link> (T1 &amp;v1, T2 &amp;v2, T3 &amp;v3)</para>
</listitem>
            <listitem><para>template&lt;typename T1 , typename T2 , typename T3 , typename T4 &gt; </para><para>long <link linkend="_class_boption_1aec7e58734109e63aa9b48a1e91651679">values</link> (T1 &amp;v1, T2 &amp;v2, T3 &amp;v3, T4 &amp;v4)</para>
</listitem>
            <listitem><para>double <link linkend="_class_boption_1a4d342b9d37288c2edf92a88e4d0626af">fill</link> (int &amp;fill_type)</para>
</listitem>
            <listitem><para><link linkend="_class_vector3">Vector3</link>&lt; double &gt; <link linkend="_class_boption_1a3871b887621c036f860c96cc296e8298">vector3</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_vector3">Vector3</link>&lt; double &gt; <link linkend="_class_boption_1adaacc01620d93986516c531d13fdf9fa">normalized_vector3</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_vector3">Vector3</link>&lt; long &gt; <link linkend="_class_boption_1a63d797fdb765359d04642ec81d0ae767">size</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_vector3">Vector3</link>&lt; long &gt; <link linkend="_class_boption_1aecc95e2cd5e7df8c3c78eb3893705bff">size2</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_vector3">Vector3</link>&lt; double &gt; <link linkend="_class_boption_1a1220a5000303fbea52004c8f6a561d70">origin</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_vector3">Vector3</link>&lt; double &gt; <link linkend="_class_boption_1a0b6c7b27275eb4fc4127e929ec0dc5c9">scale</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_vector3">Vector3</link>&lt; double &gt; <link linkend="_class_boption_1a9549850990e61c569a2444bb8ba81cd7">sampling</link> ()</para>
</listitem>
            <listitem><para>template&lt;typename T1 , typename T2 &gt; </para><para>long <link linkend="_class_boption_1a0805a8b5631dfd19c8e5e2f38d0485c3">box</link> (<link linkend="_class_vector3">Vector3</link>&lt; T1 &gt; &amp;st, <link linkend="_class_vector3">Vector3</link>&lt; T2 &gt; &amp;sz)</para>
</listitem>
            <listitem><para>template&lt;typename T1 , typename T2 &gt; </para><para>long <link linkend="_class_boption_1a83cc9215110a3f37ed41e32e3693ead1">box</link> (vector&lt; T1 &gt; &amp;st, vector&lt; T2 &gt; &amp;sz)</para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> <link linkend="_class_boption_1a69fda4f2bbfe6171eb04ae2d81a8a5f8">symmetry_string</link> ()</para>
</listitem>
            <listitem><para><link linkend="_struct_bsymmetry">Bsymmetry</link> * <link linkend="_class_boption_1aee0c4e390bc5155249b2ac8ada608727">symmetry</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_view">View</link> <link linkend="_class_boption_1adfd1b0c6d570c70e7f3f6ffe25c997ce">view</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_euler">Euler</link> <link linkend="_class_boption_1a4d0b2552191445d3d9cc373ab1db0f82">euler</link> ()</para>
</listitem>
            <listitem><para>double <link linkend="_class_boption_1af2c2be22ed9a05c9db1505fb1d8ef52a">mass</link> ()</para>
</listitem>
            <listitem><para><link linkend="_class_unit_cell">UnitCell</link> <link linkend="_class_boption_1a3196baca8398af60d906773e4ff88d7a">unit_cell</link> ()</para>
</listitem>
            <listitem><para>int <link linkend="_class_boption_1adb8df4a9da78dd07a0849a9f37ffb8f4">ctf_action</link> ()</para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Public Attributes    </title>
        <itemizedlist>
            <listitem><para><link linkend="_class_boption">Boption</link> * <link linkend="_class_boption_1a580a9942d3a8e9bbc5bfc10467558700">next</link></para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> <link linkend="_class_boption_1a280c61930edbfc04c222d6ca5a785965">tag</link></para>
</listitem>
            <listitem><para><link linkend="_class_bstring">Bstring</link> <link linkend="_class_boption_1a18101d0efb1295002f8bf41655b05341">value</link></para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>A class for a command line input option. </para>



<para><literallayout><computeroutput>Each option is defined by a tag (i.e., the string following a hyphen)
and a value (the next string after the tag).
</computeroutput></literallayout> </para>
<para>
Definition at line 26 of file options.h.</para>
</section>
<section>
<title>Constructor &amp; Destructor Documentation</title>
<anchor xml:id="_class_boption_1a0147d92142af524514c7ca812d8b97c1"/>    <section>
    <title>Boption()</title>
<indexterm><primary>Boption</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>Boption</secondary></indexterm>
<para><computeroutput>Boption::Boption (char * arg, char * arg1, const char * use[])<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 34 of file options.h.</para>
</section>
</section>
<section>
<title>Member Function Documentation</title>
<anchor xml:id="_class_boption_1a0805a8b5631dfd19c8e5e2f38d0485c3"/>    <section>
    <title>box()<computeroutput>[1/2]</computeroutput></title>
<indexterm><primary>box</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>box</secondary></indexterm>
<computeroutput>template&lt;typename T1 , typename T2 &gt; </computeroutput><para><computeroutput>long Boption::box (<link linkend="_class_vector3">Vector3</link>&lt; T1 &gt; &amp; st, <link linkend="_class_vector3">Vector3</link>&lt; T2 &gt; &amp; sz)<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 214 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a83cc9215110a3f37ed41e32e3693ead1"/>    <section>
    <title>box()<computeroutput>[2/2]</computeroutput></title>
<indexterm><primary>box</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>box</secondary></indexterm>
<computeroutput>template&lt;typename T1 , typename T2 &gt; </computeroutput><para><computeroutput>long Boption::box (vector&lt; T1 &gt; &amp; st, vector&lt; T2 &gt; &amp; sz)<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 230 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1adb8df4a9da78dd07a0849a9f37ffb8f4"/>    <section>
    <title>ctf_action()</title>
<indexterm><primary>ctf_action</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>ctf_action</secondary></indexterm>
<para><computeroutput>int Boption::ctf_action ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 303 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1adfc7980903c5ff7f725cd60e80f2f515"/>    <section>
    <title>datatype()</title>
<indexterm><primary>datatype</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>datatype</secondary></indexterm>
<para><computeroutput><link linkend="_utilities_8h_1ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</link> Boption::datatype ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 93 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a935418941b27186b4bb0eac780156fee"/>    <section>
    <title>errors()</title>
<indexterm><primary>errors</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>errors</secondary></indexterm>
<para><computeroutput>int Boption::errors ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 79 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a4d0b2552191445d3d9cc373ab1db0f82"/>    <section>
    <title>euler()</title>
<indexterm><primary>euler</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>euler</secondary></indexterm>
<para><computeroutput><link linkend="_class_euler">Euler</link> Boption::euler ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 271 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a99ceaf355a40371350fb0fbcdefa660c"/>    <section>
    <title>filename()</title>
<indexterm><primary>filename</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>filename</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link> Boption::filename ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 85 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a4d342b9d37288c2edf92a88e4d0626af"/>    <section>
    <title>fill()</title>
<indexterm><primary>fill</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>fill</secondary></indexterm>
<para><computeroutput>double Boption::fill (int &amp; fill_type)<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 138 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1ac5fececea4406b04ec9fcc9e6d5aebc4"/>    <section>
    <title>integer()</title>
<indexterm><primary>integer</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>integer</secondary></indexterm>
<para><computeroutput>long Boption::integer ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 100 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1af2c2be22ed9a05c9db1505fb1d8ef52a"/>    <section>
    <title>mass()</title>
<indexterm><primary>mass</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>mass</secondary></indexterm>
<para><computeroutput>double Boption::mass ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 281 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1adaacc01620d93986516c531d13fdf9fa"/>    <section>
    <title>normalized_vector3()</title>
<indexterm><primary>normalized_vector3</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>normalized_vector3</secondary></indexterm>
<para><computeroutput><link linkend="_class_vector3">Vector3</link>&lt;double&gt; Boption::normalized_vector3 ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 158 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a1220a5000303fbea52004c8f6a561d70"/>    <section>
    <title>origin()</title>
<indexterm><primary>origin</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>origin</secondary></indexterm>
<para><computeroutput><link linkend="_class_vector3">Vector3</link>&lt;double&gt; Boption::origin ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 180 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a06c002f5f4d9c62e95e06a54fecfdd45"/>    <section>
    <title>real()</title>
<indexterm><primary>real</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>real</secondary></indexterm>
<para><computeroutput>double Boption::real ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 107 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a9549850990e61c569a2444bb8ba81cd7"/>    <section>
    <title>sampling()</title>
<indexterm><primary>sampling</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>sampling</secondary></indexterm>
<para><computeroutput><link linkend="_class_vector3">Vector3</link>&lt;double&gt; Boption::sampling ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 202 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a0b6c7b27275eb4fc4127e929ec0dc5c9"/>    <section>
    <title>scale()</title>
<indexterm><primary>scale</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>scale</secondary></indexterm>
<para><computeroutput><link linkend="_class_vector3">Vector3</link>&lt;double&gt; Boption::scale ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 190 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a63d797fdb765359d04642ec81d0ae767"/>    <section>
    <title>size()</title>
<indexterm><primary>size</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>size</secondary></indexterm>
<para><computeroutput><link linkend="_class_vector3">Vector3</link>&lt;long&gt; Boption::size ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 163 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1aecc95e2cd5e7df8c3c78eb3893705bff"/>    <section>
    <title>size2()</title>
<indexterm><primary>size2</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>size2</secondary></indexterm>
<para><computeroutput><link linkend="_class_vector3">Vector3</link>&lt;long&gt; Boption::size2 ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 175 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1aee0c4e390bc5155249b2ac8ada608727"/>    <section>
    <title>symmetry()</title>
<indexterm><primary>symmetry</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>symmetry</secondary></indexterm>
<para><computeroutput><link linkend="_struct_bsymmetry">Bsymmetry</link>* Boption::symmetry ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 252 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a69fda4f2bbfe6171eb04ae2d81a8a5f8"/>    <section>
    <title>symmetry_string()</title>
<indexterm><primary>symmetry_string</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>symmetry_string</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link> Boption::symmetry_string ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 245 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a3196baca8398af60d906773e4ff88d7a"/>    <section>
    <title>unit_cell()</title>
<indexterm><primary>unit_cell</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>unit_cell</secondary></indexterm>
<para><computeroutput><link linkend="_class_unit_cell">UnitCell</link> Boption::unit_cell ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 291 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a1aac6da05d8db1ed5f86e5022ca89b86"/>    <section>
    <title>values()<computeroutput>[1/3]</computeroutput></title>
<indexterm><primary>values</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>values</secondary></indexterm>
<computeroutput>template&lt;typename T1 , typename T2 &gt; </computeroutput><para><computeroutput>long Boption::values (T1 &amp; v1, T2 &amp; v2)<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 115 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a1dd95807e049ae318d24a013e80974fb"/>    <section>
    <title>values()<computeroutput>[2/3]</computeroutput></title>
<indexterm><primary>values</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>values</secondary></indexterm>
<computeroutput>template&lt;typename T1 , typename T2 , typename T3 &gt; </computeroutput><para><computeroutput>long Boption::values (T1 &amp; v1, T2 &amp; v2, T3 &amp; v3)<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 122 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1aec7e58734109e63aa9b48a1e91651679"/>    <section>
    <title>values()<computeroutput>[3/3]</computeroutput></title>
<indexterm><primary>values</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>values</secondary></indexterm>
<computeroutput>template&lt;typename T1 , typename T2 , typename T3 , typename T4 &gt; </computeroutput><para><computeroutput>long Boption::values (T1 &amp; v1, T2 &amp; v2, T3 &amp; v3, T4 &amp; v4)<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 130 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a3871b887621c036f860c96cc296e8298"/>    <section>
    <title>vector3()</title>
<indexterm><primary>vector3</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>vector3</secondary></indexterm>
<para><computeroutput><link linkend="_class_vector3">Vector3</link>&lt;double&gt; Boption::vector3 ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 148 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1adfd1b0c6d570c70e7f3f6ffe25c997ce"/>    <section>
    <title>view()</title>
<indexterm><primary>view</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>view</secondary></indexterm>
<para><computeroutput><link linkend="_class_view">View</link> Boption::view ( )<computeroutput>[inline]</computeroutput></computeroutput></para><para>
Definition at line 259 of file options.h.</para>
</section>
</section>
<section>
<title>Member Data Documentation</title>
<anchor xml:id="_class_boption_1a580a9942d3a8e9bbc5bfc10467558700"/>    <section>
    <title>next</title>
<indexterm><primary>next</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>next</secondary></indexterm>
<para><computeroutput><link linkend="_class_boption">Boption</link>* Boption::next</computeroutput></para><para>
Definition at line 28 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a280c61930edbfc04c222d6ca5a785965"/>    <section>
    <title>tag</title>
<indexterm><primary>tag</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>tag</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link> Boption::tag</computeroutput></para><para>
Definition at line 29 of file options.h.</para>
    </section><anchor xml:id="_class_boption_1a18101d0efb1295002f8bf41655b05341"/>    <section>
    <title>value</title>
<indexterm><primary>value</primary><secondary>Boption</secondary></indexterm>
<indexterm><primary>Boption</primary><secondary>value</secondary></indexterm>
<para><computeroutput><link linkend="_class_bstring">Bstring</link> Boption::value</computeroutput></para><para>
Definition at line 30 of file options.h.</para>
</section>
<para>
The documentation for this class was generated from the following file:</para>
/Users/bernard/b20/bsoft/include/<link linkend="_options_8h">options.h</link></section>
</section>
