A toolkit for working with phylogenetic data.
v0.24.0
FastqOutputIterator Class Reference

#include <genesis/sequence/formats/fastq_output_iterator.hpp>

Detailed Description

Write Fastq data, sequentially.

This class allows to write Sequence data to an output target, using Fastq format, without the need to have a full SequenceSet containing all Sequences in memory.

Exemplary usage:

auto out_it = FastqOutputIterator( utils::to_file( "path/to/out.fastq" ));
while( ... ) {
    Sequence seq = ...
    out_it << seq;
}

See the output target convenience functions utils::to_file(), utils::to_stream(), and utils::to_string() for examples of how to obtain a suitable output target.

Definition at line 66 of file fastq_output_iterator.hpp.

Public Member Functions

 FastqOutputIterator ()=delete
 
 FastqOutputIterator (std::shared_ptr< utils::BaseOutputTarget > target)
 
 FastqOutputIterator (std::shared_ptr< utils::BaseOutputTarget > target, FastqWriter const &writer)
 
 FastqOutputIterator (self_type const &)=default
 
 FastqOutputIterator (self_type &&)=default
 
 ~FastqOutputIterator ()=default
 
self_typeoperator<< (Sequence const &seq)
 
self_typeoperator= (self_type const &)=default
 
self_typeoperator= (self_type &&)=default
 
FastqWriterwriter ()
 Return the FastqWriter used for this iterator. More...
 

Public Types

using self_type = FastqOutputIterator
 

Constructor & Destructor Documentation

◆ FastqOutputIterator() [1/5]

FastqOutputIterator ( )
delete

◆ FastqOutputIterator() [2/5]

FastqOutputIterator ( std::shared_ptr< utils::BaseOutputTarget target)
inlineexplicit

Definition at line 82 of file fastq_output_iterator.hpp.

◆ FastqOutputIterator() [3/5]

FastqOutputIterator ( std::shared_ptr< utils::BaseOutputTarget target,
FastqWriter const &  writer 
)
inline

Definition at line 87 of file fastq_output_iterator.hpp.

◆ ~FastqOutputIterator()

~FastqOutputIterator ( )
default

◆ FastqOutputIterator() [4/5]

FastqOutputIterator ( self_type const &  )
default

◆ FastqOutputIterator() [5/5]

FastqOutputIterator ( self_type &&  )
default

Member Function Documentation

◆ operator<<()

self_type& operator<< ( Sequence const &  seq)
inline

Definition at line 104 of file fastq_output_iterator.hpp.

◆ operator=() [1/2]

self_type& operator= ( self_type const &  )
default

◆ operator=() [2/2]

self_type& operator= ( self_type &&  )
default

◆ writer()

FastqWriter& writer ( )
inline

Return the FastqWriter used for this iterator.

Use this to change the settings and writing behaviour of the iterator. See FastqWriter for details.

Definition at line 116 of file fastq_output_iterator.hpp.

Member Typedef Documentation

◆ self_type

Definition at line 74 of file fastq_output_iterator.hpp.


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