<?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="_rwmol__star_8cpp">
<title>/Users/bernard/b20/bsoft/src/rwmol/rwmol_star.cpp File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/src/rwmol/rwmol_star.cpp</primary></indexterm>
<para>

<para>Library routines to read and write molecule files in STAR format. </para>
 
</para>
<programlisting>#include &quot;rwstar.h&quot;
#include &quot;rwmolecule.h&quot;
#include &quot;rwmol_star.h&quot;
#include &quot;mol_tags.h&quot;
#include &quot;linked_list.h&quot;
#include &quot;utilities.h&quot;
</programlisting><simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>long <link linkend="_rwmol__star_8cpp_1ad32abca4221a09fb76272fb52f91a945">read_mol_star</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmolgroup">Bmolgroup</link> *molgroup)</para>

<para>Reads a molecule group from a STAR format file. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmol__star_8cpp_1a5a521126456868f474b9393e80fc4881">item_put_atom_list</link> (<link linkend="_struct_bstar__block">Bstar_block</link> *block, const char *tag, <link linkend="_struct_bresidue">Bresidue</link> *res, const char *format)</para>
</listitem>
            <listitem><para>int <link linkend="_rwmol__star_8cpp_1aad520b936ad0075d045d620c232a3668">item_put_chain</link> (<link linkend="_struct_bstar__block">Bstar_block</link> *block, const char *tag, <link linkend="_struct_bresidue">Bresidue</link> *res, char chain)</para>
</listitem>
            <listitem><para>long <link linkend="_rwmol__star_8cpp_1a5b8e8302e2fef00e4e126b5309732cbf">write_mol_star</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmolgroup">Bmolgroup</link> *molgroup)</para>

<para>Writes a molecule group to a STAR format file. </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Variables    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rwmol__star_8cpp_1a0b2caeb4b6f130be43e5a2f0267dd453">verbose</link></para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Library routines to read and write molecule files in STAR format. </para>

<para><formalpara><title>Author: </title>

<para>Bernard Heymann </para>
</formalpara>
<formalpara><title>Date: </title>

<para>Created: 19980822 </para>

<para>Modified: 20170103 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rwmol__star_8cpp_1a5a521126456868f474b9393e80fc4881"/>    <section>
    <title>item_put_atom_list()</title>
<indexterm><primary>item_put_atom_list</primary><secondary>rwmol_star.cpp</secondary></indexterm>
<indexterm><primary>rwmol_star.cpp</primary><secondary>item_put_atom_list</secondary></indexterm>
<para><computeroutput>int item_put_atom_list (<link linkend="_struct_bstar__block">Bstar_block</link> * block, const char * tag, <link linkend="_struct_bresidue">Bresidue</link> * res, const char * format)</computeroutput></para><para>
Definition at line 233 of file rwmol_star.cpp.</para>
    </section><anchor xml:id="_rwmol__star_8cpp_1aad520b936ad0075d045d620c232a3668"/>    <section>
    <title>item_put_chain()</title>
<indexterm><primary>item_put_chain</primary><secondary>rwmol_star.cpp</secondary></indexterm>
<indexterm><primary>rwmol_star.cpp</primary><secondary>item_put_chain</secondary></indexterm>
<para><computeroutput>int item_put_chain (<link linkend="_struct_bstar__block">Bstar_block</link> * block, const char * tag, <link linkend="_struct_bresidue">Bresidue</link> * res, char chain)</computeroutput></para><para>
Definition at line 290 of file rwmol_star.cpp.</para>
    </section><anchor xml:id="_rwmol__star_8cpp_1ad32abca4221a09fb76272fb52f91a945"/>    <section>
    <title>read_mol_star()</title>
<indexterm><primary>read_mol_star</primary><secondary>rwmol_star.cpp</secondary></indexterm>
<indexterm><primary>rwmol_star.cpp</primary><secondary>read_mol_star</secondary></indexterm>
<para><computeroutput>long read_mol_star (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmolgroup">Bmolgroup</link> * molgroup)</computeroutput></para><para>

<para>Reads a molecule group from a STAR format file. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>&amp;filename</entry>
                                <entry>
<para>the file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*molgroup</entry>
                                <entry>
<para>the molecule group. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>long number of molecules read (&lt;0 if reading failed). </para>
</formalpara>
</para>
<para>
Definition at line 25 of file rwmol_star.cpp.</para>
    </section><anchor xml:id="_rwmol__star_8cpp_1a5b8e8302e2fef00e4e126b5309732cbf"/>    <section>
    <title>write_mol_star()</title>
<indexterm><primary>write_mol_star</primary><secondary>rwmol_star.cpp</secondary></indexterm>
<indexterm><primary>rwmol_star.cpp</primary><secondary>write_mol_star</secondary></indexterm>
<para><computeroutput>long write_mol_star (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmolgroup">Bmolgroup</link> * molgroup)</computeroutput></para><para>

<para>Writes a molecule group to a STAR format file. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>&amp;filename</entry>
                                <entry>
<para>the file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*molgroup</entry>
                                <entry>
<para>the molecule group. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>long number of molecules written (&lt;0 if writing failed). </para>
</formalpara>
</para>
<para>
Definition at line 324 of file rwmol_star.cpp.</para>
</section>
</section>
<section>
<title>Variable Documentation</title>
<anchor xml:id="_rwmol__star_8cpp_1a0b2caeb4b6f130be43e5a2f0267dd453"/>    <section>
    <title>verbose</title>
<indexterm><primary>verbose</primary><secondary>rwmol_star.cpp</secondary></indexterm>
<indexterm><primary>rwmol_star.cpp</primary><secondary>verbose</secondary></indexterm>
<para><computeroutput>int verbose</computeroutput></para></section>
</section>
</section>
