A library for working with phylogenetic and population genetic data.
v0.27.0
NexusWriter Class Reference

#include <genesis/utils/formats/nexus/writer.hpp>

Detailed Description

Definition at line 55 of file utils/formats/nexus/writer.hpp.

Public Member Functions

 NexusWriter ()=default
 
 NexusWriter (NexusWriter &&)=default
 
 NexusWriter (NexusWriter const &)=default
 
 ~NexusWriter ()=default
 
NexusWriteroperator= (NexusWriter &&)=default
 
NexusWriteroperator= (NexusWriter const &)=default
 
std::string to_string (NexusDocument const &document) const
 Directly return a NexusDocument as a string in Nexus format. More...
 
void write (NexusDocument const &document, std::shared_ptr< utils::BaseOutputTarget > target) const
 Write a NexusDocument to an output target, using the Nexus format. More...
 

Constructor & Destructor Documentation

◆ NexusWriter() [1/3]

NexusWriter ( )
default

◆ ~NexusWriter()

~NexusWriter ( )
default

◆ NexusWriter() [2/3]

NexusWriter ( NexusWriter const &  )
default

◆ NexusWriter() [3/3]

NexusWriter ( NexusWriter &&  )
default

Member Function Documentation

◆ operator=() [1/2]

NexusWriter& operator= ( NexusWriter &&  )
default

◆ operator=() [2/2]

NexusWriter& operator= ( NexusWriter const &  )
default

◆ to_string()

std::string to_string ( NexusDocument const &  document) const

Directly return a NexusDocument as a string in Nexus format.

This might be useful in some cases.

Definition at line 61 of file utils/formats/nexus/writer.cpp.

◆ write()

void write ( NexusDocument const &  document,
std::shared_ptr< utils::BaseOutputTarget target 
) const

Write a NexusDocument to an output target, using the Nexus format.

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 49 of file utils/formats/nexus/writer.cpp.


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