Spec BlastReportFileOut
FormattedFileOut abstraction for BlastReport

Extends FormattedFileOut
All Extended FormattedFile, FormattedFileOut
Defined in <seqan/blast.h>
Signature template <typename TBlastIOContext = BlastIOContext<>> using BlastReportFileOut = FormattedFile<BlastReport, Output, TBlastIOContext>;

Member Function Overview

Member Functions Inherited From FormattedFile

Interface Function Overview

Interface Functions Inherited From FormattedFile

Interface Functions Inherited From FormattedFileOut

Interface Metafunction Overview

Interface Metafunctions Inherited From FormattedFile

Detailed Description

This is a FormattedFile specialization for writing BlastReport formats. For details on how to influence the writing of files, see BlastIOContext. Please note that you have to specify the type of the context as a template parameter to BlastReportFileOut.

Overview

The following members of the context have to be defined before writing:

For a detailed example have a look at the Blast IO tutorial.

See Also

Interface Functions Detail

void writeFooter(blastReportOut);

Write the footer of a BlastReport.

Parameters

blastReportOut A BlastReportFileOut formattedFile.

Thrown Exceptions

IOError On low-level I/O errors.

Data Races

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

See Also

void writeHeader(blastReportOut);

Write the header (top-most section) of a BlastReport file.

Parameters

blastReportOut A BlastReportFileOut formattedFile.

Thrown Exceptions

IOError On low-level I/O errors.

Data Races

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

See Also

void writeRecord(blastReportOut, blastRecord);

write a BlastRecord including it's BlastMatches and possibly comment lines to a file.

Parameters

blastReportOut A BlastReportFileOut formattedFile.
blastRecord The BlastRecord you wish to print.

Remarks

Modifiy the formattedFile's BlastIOContext to set some properties of the output, like the versionString or dbName.

Thrown Exceptions

IOError On low-level I/O errors.

Data Races

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

See Also