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

#include <genesis/taxonomy/formats/taxonomy_writer.hpp>

Detailed Description

Write a Taxonomy as a list of Taxopaths.

Definition at line 56 of file taxonomy_writer.hpp.

Public Member Functions

 TaxonomyWriter ()=default
 
 TaxonomyWriter (TaxonomyWriter const &)=default
 
 TaxonomyWriter (TaxonomyWriter &&)=default
 
 ~TaxonomyWriter ()=default
 
TaxonomyWriteroperator= (TaxonomyWriter const &)=default
 
TaxonomyWriteroperator= (TaxonomyWriter &&)=default
 
TaxopathGeneratortaxopath_generator ()
 
void write (Taxonomy const &tax, std::shared_ptr< utils::BaseOutputTarget > target) const
 
TaxonomyWriterwrite_ids (bool value)
 
bool write_ids () const
 
TaxonomyWriterwrite_ranks (bool value)
 
bool write_ranks () const
 

Constructor & Destructor Documentation

◆ TaxonomyWriter() [1/3]

TaxonomyWriter ( )
default

◆ ~TaxonomyWriter()

~TaxonomyWriter ( )
default

◆ TaxonomyWriter() [2/3]

TaxonomyWriter ( TaxonomyWriter const &  )
default

◆ TaxonomyWriter() [3/3]

TaxonomyWriter ( TaxonomyWriter &&  )
default

Member Function Documentation

◆ operator=() [1/2]

TaxonomyWriter& operator= ( TaxonomyWriter const &  )
default

◆ operator=() [2/2]

TaxonomyWriter& operator= ( TaxonomyWriter &&  )
default

◆ taxopath_generator()

TaxopathGenerator& taxopath_generator ( )
inline

Definition at line 85 of file taxonomy_writer.hpp.

◆ write()

void write ( Taxonomy const &  tax,
std::shared_ptr< utils::BaseOutputTarget target 
) const

Definition at line 48 of file taxonomy_writer.cpp.

◆ write_ids() [1/2]

TaxonomyWriter& write_ids ( bool  value)
inline

Definition at line 90 of file taxonomy_writer.hpp.

◆ write_ids() [2/2]

bool write_ids ( ) const
inline

Definition at line 96 of file taxonomy_writer.hpp.

◆ write_ranks() [1/2]

TaxonomyWriter& write_ranks ( bool  value)
inline

Definition at line 101 of file taxonomy_writer.hpp.

◆ write_ranks() [2/2]

bool write_ranks ( ) const
inline

Definition at line 107 of file taxonomy_writer.hpp.


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