TreeContainer Class Reference

#include <CT_common.hxx>

Inheritance diagram for TreeContainer:

Public Member Functions
	~TreeContainer ()
size_t	get_tree_count () const
bool	valid_tree_index (int idx) const
const TreeInfo &	get_tree_info (int idx) const
const SizeAwareTree *	get_tree (int idx) const
SizeAwareTree *	take_tree (int idx)
void	get_species_names (ConstStrArray &species_names) const
size_t	get_species_count () const
int	add (SizeAwareTree *&tree, const char *treename)

Detailed Description

Definition at line 89 of file CT_common.hxx.

Constructor & Destructor Documentation

TreeContainer::~TreeContainer ( )

inline

Definition at line 101 of file CT_common.hxx.

References destroy().

Member Function Documentation

size_t TreeContainer::get_tree_count ( ) const

inline

Definition at line 107 of file CT_common.hxx.

References arb_assert.

Referenced by RootSynchronizer::allTreesDeconstructed(), ConsensusTreeBuilder::get(), ConsensusTreeBuilder::get_tree_remark(), multiroot_sync_subsetTrees(), rootsync_subsetTrees_vs_selected(), TreeParts::TreeParts(), and valid_tree_index().

bool TreeContainer::valid_tree_index ( int  idx ) const

inline

Definition at line 108 of file CT_common.hxx.

References get_tree_count().

Referenced by RootSynchronizer::get_edge_PART(), get_tree(), get_tree_info(), TreeParts::get_tree_PART(), and take_tree().

const TreeInfo& TreeContainer::get_tree_info ( int  idx ) const

inline

Definition at line 110 of file CT_common.hxx.

References arb_assert, and valid_tree_index().

Referenced by adjustTreeRoot(), ConsensusTreeBuilder::get(), and ConsensusTreeBuilder::get_tree_remark().

const SizeAwareTree* TreeContainer::get_tree ( int  idx ) const

inline

Definition at line 111 of file CT_common.hxx.

References arb_assert, and valid_tree_index().

Referenced by ConsensusTreeBuilder::get(), TreeParts::get_tree_PART(), and Multiroot::Multiroot().

SizeAwareTree* TreeContainer::take_tree ( int  idx )

inline

Definition at line 112 of file CT_common.hxx.

References arb_assert, NULp, and valid_tree_index().

Referenced by RootSynchronizer::take_tree().

void TreeContainer::get_species_names ( ConstStrArray &  species_names ) const

inline

Definition at line 120 of file CT_common.hxx.

References ConstStrArray::put(), and s.

Referenced by ConsensusTreeBuilder::get().

size_t TreeContainer::get_species_count ( ) const

inline

Definition at line 127 of file CT_common.hxx.

Referenced by ConsensusTreeBuilder::get(), and ConsensusTreeBuilder::get_tree_remark().

int TreeContainer::add ( SizeAwareTree *&  tree, const char *  treename  )

inline

add 'tree' with 'name'

Returns

index that can be used for get_tree() and get_tree_info()

Definition at line 129 of file CT_common.hxx.

References arb_assert, GBT_get_names_of_species_in_tree(), names, and NULp.

Referenced by ConsensusTreeBuilder::add(), and RootSynchronizer::add().

---

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

• CONSENSUS_TREE/CT_common.hxx