NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
CPhyNodeData Class Reference

Search Toolkit Book for CPhyNodeData

Data contained at each node of a phylogenetic tree. More...

#include <algo/phy_tree/phy_node.hpp>

Public Member Functions

 CPhyNodeData (void)
 
int GetId (void) const
 
void SetId (int id)
 
bool IsSetDist (void) const
 Is the distance set? More...
 
double GetDist (void) const
 Return the distance; does NOT check whether it's really set. More...
 
void SetDist (double dist)
 
void ResetDist (void)
 Make it no longer set. More...
 
const stringGetLabel (void) const
 
void SetLabel (const string &label)
 
stringSetLabel (void)
 

Private Attributes

int m_Id
 
double m_Dist
 
bool m_DistSet
 
string m_Label
 

Detailed Description

Data contained at each node of a phylogenetic tree.

Holds a label (string), a distance (double), and an integer id. Distance may not be set; IsSetDist() reports whether it is. id == -1 indicates that the id is not set.

Definition at line 48 of file phy_node.hpp.

Constructor & Destructor Documentation

◆ CPhyNodeData()

CPhyNodeData::CPhyNodeData ( void  )
inline

Definition at line 51 of file phy_node.hpp.

Member Function Documentation

◆ GetDist()

double CPhyNodeData::GetDist ( void  ) const
inline

Return the distance; does NOT check whether it's really set.

Definition at line 64 of file phy_node.hpp.

References m_Dist.

◆ GetId()

int CPhyNodeData::GetId ( void  ) const
inline

Definition at line 56 of file phy_node.hpp.

References m_Id.

◆ GetLabel()

const string& CPhyNodeData::GetLabel ( void  ) const
inline

Definition at line 69 of file phy_node.hpp.

References m_Label.

◆ IsSetDist()

bool CPhyNodeData::IsSetDist ( void  ) const
inline

Is the distance set?

Definition at line 61 of file phy_node.hpp.

References m_DistSet.

◆ ResetDist()

void CPhyNodeData::ResetDist ( void  )
inline

Make it no longer set.

Definition at line 68 of file phy_node.hpp.

References m_Dist, and m_DistSet.

◆ SetDist()

void CPhyNodeData::SetDist ( double  dist)
inline

Definition at line 65 of file phy_node.hpp.

References m_Dist, and m_DistSet.

◆ SetId()

void CPhyNodeData::SetId ( int  id)
inline

Definition at line 58 of file phy_node.hpp.

References m_Id.

◆ SetLabel() [1/2]

void CPhyNodeData::SetLabel ( const string label)
inline

Definition at line 70 of file phy_node.hpp.

References label, and m_Label.

◆ SetLabel() [2/2]

string& CPhyNodeData::SetLabel ( void  )
inline

Definition at line 71 of file phy_node.hpp.

References m_Label.

Member Data Documentation

◆ m_Dist

double CPhyNodeData::m_Dist
private

Definition at line 75 of file phy_node.hpp.

Referenced by GetDist(), ResetDist(), and SetDist().

◆ m_DistSet

bool CPhyNodeData::m_DistSet
private

Definition at line 76 of file phy_node.hpp.

Referenced by IsSetDist(), ResetDist(), and SetDist().

◆ m_Id

int CPhyNodeData::m_Id
private

Definition at line 74 of file phy_node.hpp.

Referenced by GetId(), and SetId().

◆ m_Label

string CPhyNodeData::m_Label
private

Definition at line 77 of file phy_node.hpp.

Referenced by GetLabel(), and SetLabel().


The documentation for this class was generated from the following file:
Modified on Wed May 15 15:03:24 2024 by modify_doxy.py rev. 669887