SimpleNewickEdgeData Class Reference

#include <genesis/tree/formats/newick/simple_tree.hpp>

Inherits CommonEdgeData.

Detailed Description

Data class for SimpleNewickTreeEdges.

See SimpleNewickTree for more information.

Definition at line 158 of file simple_tree.hpp.

Public Member Functions
	SimpleNewickEdgeData (SimpleNewickEdgeData &&)=delete
virtual	~SimpleNewickEdgeData () override=default
virtual std::unique_ptr< BaseEdgeData >	clone () const override
	Polymorphically copy an instance of this class. Use instead of copy constructor. More...
SimpleNewickEdgeData &	operator= (SimpleNewickEdgeData &&)=delete
virtual std::unique_ptr< BaseEdgeData >	recreate () const override
	Polymorphically create a default-constructed instance of this class with the same derived type as it was called on. More...
Public Member Functions inherited from CommonEdgeData
	CommonEdgeData (CommonEdgeData &&)=delete
virtual	~CommonEdgeData () override=default
CommonEdgeData &	operator= (CommonEdgeData &&)=delete
Public Member Functions inherited from BaseEdgeData
	BaseEdgeData (BaseEdgeData &&)=delete
	Deleted move constructor. More...
virtual	~BaseEdgeData ()=default
	Virtual destructor. Needed for polymorphism. More...
BaseEdgeData &	operator= (BaseEdgeData &&)=delete
	Deleted move assignment. More...

Static Public Member Functions
static std::unique_ptr< SimpleNewickEdgeData >	create ()
Static Public Member Functions inherited from CommonEdgeData
static std::unique_ptr< CommonEdgeData >	create ()
Static Public Member Functions inherited from BaseEdgeData
static std::unique_ptr< BaseEdgeData >	create ()
	Create a new instance of this class. Use instead of default constructor. More...

Public Attributes
std::vector< std::string >	tags
	Arbitrary strings that can be attached to a node via curly brackets "{}". More...
std::vector< std::string >	values
	Numerical values associated with the node, excluding branch lengths. More...
Public Attributes inherited from CommonEdgeData
double	branch_length = 0.0
	Branch length of the edge. More...

Protected Member Functions
	SimpleNewickEdgeData ()=default
	SimpleNewickEdgeData (SimpleNewickEdgeData const &)=default
SimpleNewickEdgeData &	operator= (SimpleNewickEdgeData const &)=default
Protected Member Functions inherited from CommonEdgeData
	CommonEdgeData ()=default
	CommonEdgeData (CommonEdgeData const &)=default
CommonEdgeData &	operator= (CommonEdgeData const &)=default
Protected Member Functions inherited from BaseEdgeData
	BaseEdgeData ()=default
	Protected default constructor. Called from the create() function. More...
	BaseEdgeData (BaseEdgeData const &)=default
	Protected copy constructor. Called from the clone() function. More...
BaseEdgeData &	operator= (BaseEdgeData const &)=default
	Protected copy assignment. Not used right now. More...

Constructor & Destructor Documentation

~SimpleNewickEdgeData()

virtual ~SimpleNewickEdgeData ( )

overridevirtualdefault

SimpleNewickEdgeData() [1/3]

SimpleNewickEdgeData ( SimpleNewickEdgeData &&  )

delete

SimpleNewickEdgeData() [2/3]

SimpleNewickEdgeData ( )

protecteddefault

SimpleNewickEdgeData() [3/3]

SimpleNewickEdgeData ( SimpleNewickEdgeData const &  )

protecteddefault

Member Function Documentation

clone()

virtual std::unique_ptr< BaseEdgeData > clone ( ) const

inlineoverridevirtual

Polymorphically copy an instance of this class. Use instead of copy constructor.

Reimplemented from CommonEdgeData.

Definition at line 192 of file simple_tree.hpp.

create()

static std::unique_ptr< SimpleNewickEdgeData > create ( )

inlinestatic

Definition at line 182 of file simple_tree.hpp.

operator=() [1/2]

SimpleNewickEdgeData& operator= ( SimpleNewickEdgeData &&  )

delete

operator=() [2/2]

SimpleNewickEdgeData& operator= ( SimpleNewickEdgeData const &  )

protecteddefault

recreate()

virtual std::unique_ptr< BaseEdgeData > recreate ( ) const

inlineoverridevirtual

Polymorphically create a default-constructed instance of this class with the same derived type as it was called on.

Reimplemented from CommonEdgeData.

Definition at line 187 of file simple_tree.hpp.

Member Data Documentation

tags

std::vector<std::string> tags

Arbitrary strings that can be attached to a node via curly brackets "{}".

This is a custom extension of the Newick format used in the Jplace file format for phylogenetic placements.

Definition at line 215 of file simple_tree.hpp.

values

std::vector<std::string> values

Numerical values associated with the node, excluding branch lengths.

Edge values are part of the origina Newick format, and hence already stored in the CommonEdgeData.

Definition at line 207 of file simple_tree.hpp.

---

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

• simple_tree.hpp