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

#include <genesis/tree/common_tree/phyloxml_writer.hpp>

Inherits PhyloxmlWriter, and CommonTreePhyloxmlWriterPlugin.

Detailed Description

Definition at line 121 of file phyloxml_writer.hpp.

Public Member Functions

 CommonTreePhyloxmlWriter ()
 
- Public Member Functions inherited from PhyloxmlWriter
 PhyloxmlWriter ()=default
 
 PhyloxmlWriter (PhyloxmlWriter const &)=default
 
 PhyloxmlWriter (PhyloxmlWriter &&)=default
 
virtual ~PhyloxmlWriter ()=default
 
PhyloxmlWriteroperator= (PhyloxmlWriter const &)=default
 
PhyloxmlWriteroperator= (PhyloxmlWriter &&)=default
 
void to_document (Tree const &tree, utils::XmlDocument &xml) const
 Store the information of the tree into an Phyloxml-formatted XmlDocument. More...
 
void write (Tree const &tree, std::shared_ptr< utils::BaseOutputTarget > target) const
 Write a Tree to an output target, using the Phyloxml format. More...
 
- Public Member Functions inherited from CommonTreePhyloxmlWriterPlugin
 CommonTreePhyloxmlWriterPlugin ()=default
 
 CommonTreePhyloxmlWriterPlugin (CommonTreePhyloxmlWriterPlugin const &)=default
 
 CommonTreePhyloxmlWriterPlugin (CommonTreePhyloxmlWriterPlugin &&)=default
 
virtual ~CommonTreePhyloxmlWriterPlugin ()=default
 
void edge_to_element (TreeEdge const &edge, utils::XmlElement &element) const
 
void node_to_element (TreeNode const &node, utils::XmlElement &element) const
 
CommonTreePhyloxmlWriterPluginoperator= (CommonTreePhyloxmlWriterPlugin const &)=default
 
CommonTreePhyloxmlWriterPluginoperator= (CommonTreePhyloxmlWriterPlugin &&)=default
 
void register_with (PhyloxmlWriter &writer) const
 

Additional Inherited Members

- Public Types inherited from PhyloxmlWriter
using edge_to_element_function = std::function< void(TreeEdge const &edge, utils::XmlElement &element) >
 Function type that translates from a TreeEdge to an XmlElement. More...
 
using finish_writing_function = std::function< void(Tree const &tree, utils::XmlDocument &xml) >
 Function type that allows to do some finalizing work with the Tree and XmlDocument after the actual tree writing finished. More...
 
using node_to_element_function = std::function< void(TreeNode const &node, utils::XmlElement &element) >
 Function type that translates from a TreeNode to an XmlElement. More...
 
using prepare_writing_function = std::function< void(Tree const &tree, utils::XmlDocument &xml) >
 Function type that allows to do some preparatory work with the Tree and XmlDocument before the actual tree writing begins. More...
 
- Public Attributes inherited from PhyloxmlWriter
std::vector< edge_to_element_functionedge_to_element_plugins
 Collect all functions to be called for each TreeEdge in order to translate it to a Phyloxml representation. More...
 
std::vector< finish_writing_functionfinish_writing_plugins
 Collect all functions to be called after finishing the actual tree writing. More...
 
std::vector< node_to_element_functionnode_to_element_plugins
 Collect all functions to be called for each TreeNode in order to translate it to a Phyloxml representation. More...
 
std::vector< prepare_writing_functionprepare_writing_plugins
 Collect all functions to be called before starting the actual tree writing. More...
 

Constructor & Destructor Documentation

◆ CommonTreePhyloxmlWriter()

Definition at line 131 of file phyloxml_writer.hpp.


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