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

#include <genesis/placement/placement_tree.hpp>

Inherits CommonNodeData.

Detailed Description

Data class for PlacementTreeNodes. Stores a node name.

This class is derived from tree::CommonNodeData and currently adds no functionality on top of this base class. See there for more information. Also, see PlacementTree for information on how and where this class is used.

Definition at line 87 of file placement_tree.hpp.

Public Member Functions

 PlacementNodeData (PlacementNodeData &&)=delete
 
virtual ~PlacementNodeData () override=default
 
virtual std::unique_ptr< BaseNodeDataclone () const override
 Polymorphically copy an instance of this class. Use instead of copy constructor. More...
 
PlacementNodeDataoperator= (PlacementNodeData &&)=delete
 
virtual std::unique_ptr< BaseNodeDatarecreate () 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 CommonNodeData
 CommonNodeData (CommonNodeData &&)=delete
 
virtual ~CommonNodeData () override=default
 
CommonNodeDataoperator= (CommonNodeData &&)=delete
 
- Public Member Functions inherited from BaseNodeData
 BaseNodeData (BaseNodeData &&)=delete
 Deleted move constructor. More...
 
virtual ~BaseNodeData ()=default
 Virtual destructor. Needed for polymorphism. More...
 
BaseNodeDataoperator= (BaseNodeData &&)=delete
 Deleted move assignment. More...
 

Static Public Member Functions

static std::unique_ptr< PlacementNodeDatacreate ()
 
- Static Public Member Functions inherited from CommonNodeData
static std::unique_ptr< CommonNodeDatacreate ()
 
- Static Public Member Functions inherited from BaseNodeData
static std::unique_ptr< BaseNodeDatacreate ()
 Create a new instance of this class. Use instead of default constructor. More...
 

Protected Member Functions

 PlacementNodeData ()=default
 
 PlacementNodeData (PlacementNodeData const &)=default
 
PlacementNodeDataoperator= (PlacementNodeData const &)=default
 
- Protected Member Functions inherited from CommonNodeData
 CommonNodeData ()=default
 
 CommonNodeData (CommonNodeData const &)=default
 
CommonNodeDataoperator= (CommonNodeData const &)=default
 
- Protected Member Functions inherited from BaseNodeData
 BaseNodeData ()=default
 Protected default constructor. Called from the create() function. More...
 
 BaseNodeData (BaseNodeData const &)=default
 Protected copy constructor. Called from the clone() function. More...
 
BaseNodeDataoperator= (BaseNodeData const &)=default
 Protected copy assignment. Not used right now. More...
 

Additional Inherited Members

- Public Attributes inherited from CommonNodeData
std::string name
 Name of the node. More...
 

Constructor & Destructor Documentation

◆ ~PlacementNodeData()

virtual ~PlacementNodeData ( )
overridevirtualdefault

◆ PlacementNodeData() [1/3]

◆ PlacementNodeData() [2/3]

PlacementNodeData ( )
protecteddefault

◆ PlacementNodeData() [3/3]

PlacementNodeData ( PlacementNodeData const &  )
protecteddefault

Member Function Documentation

◆ clone()

virtual std::unique_ptr< BaseNodeData > clone ( ) const
inlineoverridevirtual

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

Reimplemented from CommonNodeData.

Definition at line 121 of file placement_tree.hpp.

◆ create()

static std::unique_ptr< PlacementNodeData > create ( )
inlinestatic

Definition at line 111 of file placement_tree.hpp.

◆ operator=() [1/2]

PlacementNodeData& operator= ( PlacementNodeData &&  )
delete

◆ operator=() [2/2]

PlacementNodeData& operator= ( PlacementNodeData const &  )
protecteddefault

◆ recreate()

virtual std::unique_ptr< BaseNodeData > recreate ( ) const
inlineoverridevirtual

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

Reimplemented from CommonNodeData.

Definition at line 116 of file placement_tree.hpp.


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