Spec RnaStructFileIn

Class for reading DBN, DBV, CT, STH, BPSEQ, and EBPSEQ files containing RNA structures.

/*!
 * @class RnaStructFileIn
 * 
 * @extends FormattedFileIn
 * 
 * @headerfile <seqan/rna_io.h>
 * 
 * @brief Class for reading DBN, DBV, CT, STH, BPSEQ, and EBPSEQ files
 *        containing RNA structures.
 * 
 * @signature typedef FormattedFile<RnaStruct, Input> RnaStructFileIn;
 * 
 * @fn RnaStructFileIn#readRecord
 * 
 * @brief Read one @link FormattedFileRecordConcept @endlink from an @link
 *        RnaStructFileIn @endlink object.
 * 
 * @signature void readRecord(record, fileIn);
 * 
 * @param[in,out] record The @link RnaRecord @endlink object where to write the
 *                       information into.
 * @param[in] fileIn The @link RnaStructFileIn @endlink object to read from.
 * 
 * @throw IOError On low-level I/O errors.
 * @throw ParseError On high-level file format errors.
 * 
 * @fn RnaStructFileIn#readHeader
 * 
 * @brief Read one @link FormattedFileHeaderConcept @endlink from an @link
 *        RnaStructFileIn @endlink object.
 * 
 * @signature void readHeader(header, fileIn);
 * 
 * @param[in,out] header The @link RnaHeader @endlink object where to write the
 *                       information into.
 * @param[in] fileIn The @link RnaStructFileIn @endlink object to read from.
 * 
 * @throw IOError On low-level I/O errors.
 * @throw ParseError On high-level file format errors.
 * 
 * @fn RnaStructFileIn#readRecords
 * 
 * @brief Read @link RnaStructContents @endlink from a @link RnaStructFileIn
 *        @endlink object.
 * 
 * @signature void readRecords(contents, fileIn, maxRecords);
 * 
 * @param[in,out] contents The @link RnaStructContents @endlink object where to
 *                         write the information into.
 * @param[in] fileIn The @link RnaStructFileIn @endlink object to read from.
 * @param[in] maxRecords The maximum number of records to read.
 * 
 * @throw IOError On low-level I/O errors.
 * @throw ParseError On high-level file format errors.
 * 
 * @see RnaStructFileIn#readRecord
 * @see RnaStructFileIn#readHeader
 */