<?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_8h">
<title>/Users/bernard/b20/bsoft/include/rwmol_star.h File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/include/rwmol_star.h</primary></indexterm>
<para>

<para>Read and write molecules in STAR format. </para>
 
</para>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>long <link linkend="_rwmol__star_8h_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>long <link linkend="_rwmol__star_8h_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>
<section>
<title>Detailed Description</title>

<para>Read and write molecules in STAR format. </para>

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

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

<para>Created: 19991113 </para>

<para>Modified: 20050908 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rwmol__star_8h_1ad32abca4221a09fb76272fb52f91a945"/>    <section>
    <title>read_mol_star()</title>
<indexterm><primary>read_mol_star</primary><secondary>rwmol_star.h</secondary></indexterm>
<indexterm><primary>rwmol_star.h</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_8h_1a5b8e8302e2fef00e4e126b5309732cbf"/>    <section>
    <title>write_mol_star()</title>
<indexterm><primary>write_mol_star</primary><secondary>rwmol_star.h</secondary></indexterm>
<indexterm><primary>rwmol_star.h</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>
