#include <genesis/placement/placement_tree.hpp>
Inherits CommonEdgeData.
Data class for PlacementTreeEdges. Stores the branch length of the edge, and the edge_num
, as defined in the jplace
standard.
This class is derived from tree::CommonEdgeData. See there for more information. Also, see PlacementTree for information on how and where this class is used.
Definition at line 139 of file placement_tree.hpp.
Public Member Functions | |
PlacementEdgeData (PlacementEdgeData &&)=delete | |
virtual | ~PlacementEdgeData () override=default |
virtual std::unique_ptr< BaseEdgeData > | clone () const override |
Polymorphically copy an instance of this class. Use instead of copy constructor. More... | |
EdgeNumType | edge_num () const |
Return the edge_num of this edge. This value is defined by the jplace standard. More... | |
PlacementEdgeData & | operator= (PlacementEdgeData &&)=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... | |
void | reset_edge_num (EdgeNumType val) |
Force to set the edge_num to a certain value. More... | |
![]() | |
CommonEdgeData (CommonEdgeData &&)=delete | |
virtual | ~CommonEdgeData () override=default |
CommonEdgeData & | operator= (CommonEdgeData &&)=delete |
![]() | |
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< PlacementEdgeData > | create () |
![]() | |
static std::unique_ptr< CommonEdgeData > | create () |
![]() | |
static std::unique_ptr< BaseEdgeData > | create () |
Create a new instance of this class. Use instead of default constructor. More... | |
Public Types | |
using | EdgeNumType = int |
Data type used for the edge_num() property of the edges in a PlacementTree. More... | |
Protected Member Functions | |
PlacementEdgeData ()=default | |
PlacementEdgeData (PlacementEdgeData const &)=default | |
PlacementEdgeData & | operator= (PlacementEdgeData const &)=default |
![]() | |
CommonEdgeData ()=default | |
CommonEdgeData (CommonEdgeData const &)=default | |
CommonEdgeData & | operator= (CommonEdgeData const &)=default |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
double | branch_length = 0.0 |
Branch length of the edge. More... | |
|
overridevirtualdefault |
|
delete |
|
protecteddefault |
|
protecteddefault |
|
inlineoverridevirtual |
Polymorphically copy an instance of this class. Use instead of copy constructor.
Reimplemented from CommonEdgeData.
Definition at line 182 of file placement_tree.hpp.
|
inlinestatic |
Definition at line 172 of file placement_tree.hpp.
|
inline |
Return the edge_num
of this edge. This value is defined by the jplace
standard.
Definition at line 194 of file placement_tree.hpp.
|
delete |
|
protecteddefault |
|
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 177 of file placement_tree.hpp.
|
inline |
Force to set the edge_num to a certain value.
The edge_num is usually considered to be constant for the tree. It rarely needs to be set, except for when constructing the object. Use with care.
Definition at line 205 of file placement_tree.hpp.
using EdgeNumType = int |
Data type used for the edge_num() property of the edges in a PlacementTree.
Definition at line 150 of file placement_tree.hpp.