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

Extends FormattedFileIn
All Extended FormattedFile, FormattedFileIn
Defined in <seqan/rna_io.h>
Signature typedef FormattedFile<RnaStruct, Input> RnaStructFileIn;

Member Function Overview

Member Functions Inherited From FormattedFile

Interface Function Overview

Interface Functions Inherited From FormattedFile

Interface Functions Inherited From FormattedFileIn

Interface Metafunction Overview

Interface Metafunctions Inherited From FormattedFile

Interface Functions Detail

void readHeader(header, fileIn);

Read one FormattedFileHeaderConcept from an RnaStructFileIn object.

Parameters

header The RnaHeader object where to write the information into.
fileIn The RnaStructFileIn object to read from.

Thrown Exceptions

IOError On low-level I/O errors.
ParseError On high-level file format errors.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void readRecord(record, fileIn);

Read one FormattedFileRecordConcept from an RnaStructFileIn object.

Parameters

record The RnaRecord object where to write the information into.
fileIn The RnaStructFileIn object to read from.

Thrown Exceptions

IOError On low-level I/O errors.
ParseError On high-level file format errors.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

void readRecords(contents, fileIn, maxRecords);

Read RnaStructContents from a RnaStructFileIn object.

Parameters

contents The RnaStructContents object where to write the information into.
fileIn The RnaStructFileIn object to read from.
maxRecords The maximum number of records to read.

Thrown Exceptions

IOError On low-level I/O errors.
ParseError On high-level file format errors.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

See Also