SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
seqan3::align_cfg::output_sequence1_id Class Reference

Configures the alignment result to output the id of the first sequence. More...

#include <seqan3/alignment/configuration/align_config_output.hpp>

+ Inheritance diagram for seqan3::align_cfg::output_sequence1_id:

Public Member Functions

Constructor, destructor and assignment
constexpr output_sequence1_id ()=default
 Defaulted.
 
constexpr output_sequence1_id (output_sequence1_id const &)=default
 Defaulted.
 
constexpr output_sequence1_id (output_sequence1_id &&)=default
 Defaulted.
 
constexpr output_sequence1_idoperator= (output_sequence1_id const &)=default
 Defaulted.
 
constexpr output_sequence1_idoperator= (output_sequence1_id &&)=default
 Defaulted.
 
 ~output_sequence1_id ()=default
 

Detailed Description

Configures the alignment result to output the id of the first sequence.

This option forces the alignment to output the id of the first sequence.

If this option is not set in the alignment configuration, accessing the id of the first sequence via the seqan3::alignment_result object is forbidden and will lead to a compile time error.

Example

int main()
{
// Output only the id of the first sequence.
}
See also
seqan3::align_cfg::output_score
seqan3::align_cfg::output_end_position
seqan3::align_cfg::output_begin_position
seqan3::align_cfg::output_alignment
seqan3::align_cfg::output_sequence2_id

Constructor & Destructor Documentation

◆ ~output_sequence1_id()

seqan3::align_cfg::output_sequence1_id::~output_sequence1_id ( )
default

Defaulted.


The documentation for this class was generated from the following file:
seqan3::align_cfg::output_sequence1_id
Configures the alignment result to output the id of the first sequence.
Definition: align_config_output.hpp:207
seqan3::configuration
Collection of elements to configure an algorithm.
Definition: configuration.hpp:82
align_config_output.hpp
Provides configuration for alignment output.