A library for working with phylogenetic and population genetic data.
PhyloxmlColorWriterPlugin Class Reference

#include <genesis/tree/formats/phyloxml/color_writer_plugin.hpp>

Inherits ColorWriterPlugin.

Detailed Description

Plugin class for PhyloXML output that allows coloring of edges.

The effect of this class on the PhyloXML output is that (if enabled) a color tag will be added to each clade like this:

    [other tags, like name or branch_length]

For more information, see ColorWriterPlugin class.

Definition at line 66 of file phyloxml/color_writer_plugin.hpp.

Public Member Functions

 PhyloxmlColorWriterPlugin ()=default
 PhyloxmlColorWriterPlugin (PhyloxmlColorWriterPlugin &&)=default
 PhyloxmlColorWriterPlugin (PhyloxmlColorWriterPlugin const &)=default
virtual ~PhyloxmlColorWriterPlugin ()=default
void edge_to_element (TreeEdge const &edge, utils::XmlElement &element) const
PhyloxmlColorWriterPluginoperator= (PhyloxmlColorWriterPlugin &&)=default
PhyloxmlColorWriterPluginoperator= (PhyloxmlColorWriterPlugin const &)=default
void prepare_writing (Tree const &tree, utils::XmlDocument &xml) const
void register_with (PhyloxmlWriter &writer) const
- Public Member Functions inherited from ColorWriterPlugin
virtual ~ColorWriterPlugin ()=default
std::vector< utils::Color > const & edge_colors () const
 Return the edge colors that are currently set. More...
void edge_colors (std::vector< utils::Color > const &color_vector)
 Set the edge colors that shall be written to the output. More...
bool enable_color () const
 Returns whether colors tags are written to the output. More...
void enable_color (bool value)
 Set whether colors tags are written to the output. More...
utils::Color ignored_color () const
 Return the currently set ignored color. See the setter for more information. More...
void ignored_color (utils::Color value)
 Set a color that is used as marker for partially disabling the output of color tags. More...
bool use_ignored_color () const
 Return whether currently an ignored color is used. More...
void use_ignored_color (bool value)
 Set whether to use the ignored_color(). More...

Constructor & Destructor Documentation

◆ PhyloxmlColorWriterPlugin() [1/3]

◆ ~PhyloxmlColorWriterPlugin()

virtual ~PhyloxmlColorWriterPlugin ( )

◆ PhyloxmlColorWriterPlugin() [2/3]

◆ PhyloxmlColorWriterPlugin() [3/3]

Member Function Documentation

◆ edge_to_element()

void edge_to_element ( TreeEdge const &  edge,
utils::XmlElement element 
) const

Definition at line 106 of file phyloxml/color_writer_plugin.hpp.

◆ operator=() [1/2]

◆ operator=() [2/2]

PhyloxmlColorWriterPlugin& operator= ( PhyloxmlColorWriterPlugin const &  )

◆ prepare_writing()

void prepare_writing ( Tree const &  tree,
utils::XmlDocument xml 
) const

Definition at line 87 of file phyloxml/color_writer_plugin.hpp.

◆ register_with()

void register_with ( PhyloxmlWriter writer) const

Definition at line 119 of file phyloxml/color_writer_plugin.hpp.

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