Spec RnaStructFileOut

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

/*!
 * @class RnaStructFileOut
 * 
 * @extends FormattedFileOut
 * 
 * @headerfile <seqan/rna_io.h>
 * 
 * @brief Class for writing DBN, DBV, CT, STH, BPSEQ, and EBPSEQ files
 *        containing RNA structures.
 * 
 * @signature typedef FormattedFile<RnaStruct, Output> RnaStructFileOut;
 * 
 * @fn RnaStructFileOut#writeRecord
 * 
 * @brief Write one @link FormattedFileRecordConcept @endlink into an @link
 *        RnaStructFileOut @endlink object.
 * 
 * @signature void writeRecord(fileOut, record);
 * 
 * @param[in,out] fileOut The @link RnaStructFileOut @endlink object to write
 *                        into.
 * @param[in] record The @link RnaRecord @endlink object where to read from.
 * 
 * @throw IOError On low-level I/O errors.
 * @throw ParseError On high-level file format errors.
 * 
 * @fn RnaStructFileOut#writeHeader
 * 
 * @brief Write one @link FormattedFileHeaderConcept @endlink into an @link
 *        RnaStructFileOut @endlink object.
 * 
 * @signature void writeHeader(fileOut, header);
 * 
 * @param[in,out] fileOut The @link RnaStructFileOut @endlink object to write
 *                        into.
 * @param[in] record The @link RnaHeader @endlink object where to read from.
 * 
 * @throw IOError On low-level I/O errors.
 * @throw ParseError On high-level file format errors.
 * 
 * @fn RnaStructFileOut#writeRecords
 * 
 * @brief Write @link RnaStructContents @endlink into a @link RnaStructFileOut
 *        @endlink object.
 * 
 * @signature void writeRecords(fileOut, contents);
 * 
 * @param[in,out] fileOut The @link RnaStructFileOut @endlink object to write
 *                        into.
 * @param[in] contents The @link RnaStructContents @endlink object where to read
 *                     from.
 * 
 * @throw IOError On low-level I/O errors.
 * @throw ParseError On high-level file format errors.
 * 
 * @see RnaStructFileOut#writeRecord
 * @see RnaStructFileOut#writeHeader
 */