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

<para>Header file for reading residue property files. </para>
 
</para>
<programlisting>#include &quot;Bstring.h&quot;
</programlisting><simplesect>
    <title>Classes    </title>
        <itemizedlist>
            <listitem><para>struct <link linkend="_struct_bresidue__type">Bresidue_type</link></para>
</listitem>
            <listitem><para>struct <link linkend="_struct_bresidue__matrix">Bresidue_matrix</link></para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Macros    </title>
        <itemizedlist>
            <listitem><para>#define <link linkend="_rwresprop_8h_1a45404c3c762f1e48cf9294137747f1cd">MAXRES</link>   25</para>
</listitem>
            <listitem><para>#define <link linkend="_rwresprop_8h_1a05005f061a9c6893db2da37f36de3ba1">_Brestype_</link></para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para><link linkend="_struct_bresidue__type">Bresidue_type</link> * <link linkend="_rwresprop_8h_1a42c9985c5db6edd823ce180e258dfef8">get_residue_properties</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename)</para>

<para>Reading residue properties from parameter files. </para>
</listitem>
            <listitem><para>int <link linkend="_rwresprop_8h_1aaf53417d13a6d74673819ce3d73d6a19">write_residue_properties</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bresidue__type">Bresidue_type</link> *rt)</para>

<para>Writing residue properties from a parameter file. </para>
</listitem>
            <listitem><para><link linkend="_struct_bresidue__matrix">Bresidue_matrix</link> * <link linkend="_rwresprop_8h_1aba09db586847121bd20eefa4abe085ad">get_residue_matrix</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename)</para>

<para>Reading a residue matrix from a file. </para>
</listitem>
            <listitem><para>int <link linkend="_rwresprop_8h_1a36a63ac68c6da6483f7c79236359d100">residue_matrix_kill</link> (<link linkend="_struct_bresidue__matrix">Bresidue_matrix</link> *resmat)</para>

<para>Deallocating a residue matrix. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Header file for reading residue property files. </para>

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

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

<para>Created: 19980822 </para>

<para>Modified: 20100916 </para>
</formalpara>
</para>
</section>
<section>
<title>Macro Definition Documentation</title>
<anchor xml:id="_rwresprop_8h_1a05005f061a9c6893db2da37f36de3ba1"/>    <section>
    <title>_Brestype_</title>
<indexterm><primary>_Brestype_</primary><secondary>rwresprop.h</secondary></indexterm>
<indexterm><primary>rwresprop.h</primary><secondary>_Brestype_</secondary></indexterm>
<para><computeroutput>#define _Brestype_</computeroutput></para><para>
Definition at line 50 of file rwresprop.h.</para>
    </section><anchor xml:id="_rwresprop_8h_1a45404c3c762f1e48cf9294137747f1cd"/>    <section>
    <title>MAXRES</title>
<indexterm><primary>MAXRES</primary><secondary>rwresprop.h</secondary></indexterm>
<indexterm><primary>rwresprop.h</primary><secondary>MAXRES</secondary></indexterm>
<para><computeroutput>#define MAXRES   25</computeroutput></para><para>
Definition at line 12 of file rwresprop.h.</para>
</section>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rwresprop_8h_1aba09db586847121bd20eefa4abe085ad"/>    <section>
    <title>get_residue_matrix()</title>
<indexterm><primary>get_residue_matrix</primary><secondary>rwresprop.h</secondary></indexterm>
<indexterm><primary>rwresprop.h</primary><secondary>get_residue_matrix</secondary></indexterm>
<para><computeroutput><link linkend="_struct_bresidue__matrix">Bresidue_matrix</link>* get_residue_matrix (<link linkend="_class_bstring">Bstring</link> &amp; filename)</computeroutput></para><para>

<para>Reading a residue matrix from a 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>file name. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>Bresidue_matrix* residue matrix property structure, NULL on failure. </para>
</formalpara>
</para>
<para>
Definition at line 164 of file rwresprop.cpp.</para>
    </section><anchor xml:id="_rwresprop_8h_1a42c9985c5db6edd823ce180e258dfef8"/>    <section>
    <title>get_residue_properties()</title>
<indexterm><primary>get_residue_properties</primary><secondary>rwresprop.h</secondary></indexterm>
<indexterm><primary>rwresprop.h</primary><secondary>get_residue_properties</secondary></indexterm>
<para><computeroutput><link linkend="_struct_bresidue__type">Bresidue_type</link>* get_residue_properties (<link linkend="_class_bstring">Bstring</link> &amp; filename)</computeroutput></para><para>

<para>Reading residue properties from parameter files. </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>file name. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>Bresidue_type* the residue property structure, NULL on failure. </para>
</formalpara>
</para>
<para>
Definition at line 99 of file rwresprop.cpp.</para>
    </section><anchor xml:id="_rwresprop_8h_1a36a63ac68c6da6483f7c79236359d100"/>    <section>
    <title>residue_matrix_kill()</title>
<indexterm><primary>residue_matrix_kill</primary><secondary>rwresprop.h</secondary></indexterm>
<indexterm><primary>rwresprop.h</primary><secondary>residue_matrix_kill</secondary></indexterm>
<para><computeroutput>int residue_matrix_kill (<link linkend="_struct_bresidue__matrix">Bresidue_matrix</link> * resmat)</computeroutput></para><para>

<para>Deallocating a residue matrix. </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>*resmat</entry>
                                <entry>
<para>the residue matrix property structure. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0. </para>
</formalpara>
</para>
<para>
Definition at line 208 of file rwresprop.cpp.</para>
    </section><anchor xml:id="_rwresprop_8h_1aaf53417d13a6d74673819ce3d73d6a19"/>    <section>
    <title>write_residue_properties()</title>
<indexterm><primary>write_residue_properties</primary><secondary>rwresprop.h</secondary></indexterm>
<indexterm><primary>rwresprop.h</primary><secondary>write_residue_properties</secondary></indexterm>
<para><computeroutput>int write_residue_properties (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bresidue__type">Bresidue_type</link> * rt)</computeroutput></para><para>

<para>Writing residue properties from a parameter 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>file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*rt</entry>
                                <entry>
<para>the residue property structure. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int error code (&lt;0 means failure). </para>
</formalpara>
</para>
<para>
Definition at line 152 of file rwresprop.cpp.</para>
</section>
</section>
</section>
