SeqAn3
seqan3::structure_file_output_format_concept Interface Reference

The generic concept for sequence file out formats. More...

#include <seqan3/io/structure_file/output_format_concept.hpp>

Inheritance diagram for seqan3::structure_file_output_format_concept:
[legend]

Requirements for seqan3::structure_file_output_format_concept

You can expect these members on all types that implement seqan3::structure_file_output_format_concept.

void write (stream_type &stream, structure_file_output_options const &options, seq_type &&seq, id_type &&id, bpp_type &&bpp, structure_type &&structure, energy_type &&energy, react_type &&react, react_type &&react_err, comment_type &&comment, offset_type &&offset)
 Write the given fields to the specified stream. More...
 
static inline std::vector< std::string > file_extensions
 The format type is required to provide a vector of all supported file extensions.
 

Detailed Description

The generic concept for sequence file out formats.

The details of this concept are only relevant to developers who wish to implement their own format. The requirements for this concept are given as related functions and metafunctions. Types that satisfy this concept are shown as "implementing this interface".

Member Function Documentation

◆ write()

void write ( stream_type &  stream,
structure_file_output_options const &  options,
seq_type &&  seq,
id_type &&  id,
bpp_type &&  bpp,
structure_type &&  structure,
energy_type &&  energy,
react_type &&  react,
react_type &&  react_err,
comment_type &&  comment,
offset_type &&  offset 
)

Write the given fields to the specified stream.

Template Parameters
stream_typeOutput stream, must satisfy seqan3::ostream_concept with char.
seq_typeType of the seqan3::field::SEQ output; must satisfy std::ranges::OutputRange over a seqan3::alphabet_concept.
id_typeType of the seqan3::field::ID output; must satisfy std::ranges::OutputRange over a seqan3::alphabet_concept.
bpp_typeType of the seqan3::field::BPP output; must satisfy std::ranges::OutputRange over a set of pair of types satisfying std::is_floating_point and std::numeric_limits::is_integer, respectively.
structure_typeType of the seqan3::field::STRUCTURE output; must satisfy std::ranges::OutputRange over a seqan3::rna_structure_concept.
energy_typeType of the seqan3::field::ENERGY output; must satisfy std::is_floating_point.
react_typeType of the seqan3::field::REACT and seqan3::field::REACT_ERR output; must satisfy std::is_floating_point.
comment_typeType of the seqan3::field::COMMENT output; must satisfy std::ranges::OutputRange over a seqan3::alphabet_concept.
offset_typeType of the seqan3::field::OFFSET output; must satisfy std::numeric_limits::is_integer.
Parameters
[in,out]streamThe output stream to write into.
[in]optionsFile specific options passed to the format.
[in]seqThe data for seqan3::field::SEQ output, i.e. the "sequence".
[in]idThe data for seqan3::field::ID output, e.g. the header line.
[in]bppThe data for seqan3::field::BPP output.
[in]structureThe data for seqan3::field::STRUCTURE output.
[in]energyThe data for seqan3::field::ENERGY output.
[in]reactThe data for seqan3::field::REACT output.
[in]react_errThe data for seqan3::field::REACT_ERR output.
[in]commentThe data for seqan3::field::COMMENT output.
[in]offsetThe data for seqan3::field::OFFSET output.

Additional requirements

  • The format must also accept std::ignore as parameter for any of the fields, however it shall throw an exception if one of the fields required for writing the format is marked as such. [this shall be checked inside the function]
  • The format does not handle seqan3::field::STRUCTURED_SEQ, instead seqan3::structure_file_out splits it into two views and passes it to the format as if they were separate.

Implemented in seqan3::structure_file_format_vienna.


The documentation for this interface was generated from the following file: