Spec FormattedFileOut
Base class for writing formatted files.

Extends FormattedFile
All Extended FormattedFile
All Subcl's BamFileOut, BedFileOut, BlastReportFileOut, BlastTabularFileOut, GffFileOut, RnaStructFileOut, RoiFileOut, SeqFileOut, SimpleIntervalsFileInOut, UcscFileOut, VcfFileOut
Defined in <seqan/stream.h>
Signature typedef FormattedFile<TFileFormat, Output, TSpec> FormattedFileOut;

Member Function Overview

Member Functions Inherited From FormattedFile

Interface Function Overview

Interface Functions Inherited From FormattedFile

Interface Metafunction Overview

Interface Metafunctions Inherited From FormattedFile

Detailed Description

A formatted output file can write Header and Records.

Interface Functions Detail

void writeHeader(fileOut, header);

Parameters

fileOut The FormattedFileOut object to write into.
header The FormattedFileHeaderConcept to write.

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 writeRecord(fileOut, record);

Parameters

fileOut The FormattedFileOut object to write into.
record The FormattedFileRecordConcept to write.

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.