Search Toolkit Book for CBioTreeContainer

#include <objects/biotree/BioTreeContainer.hpp>

Inheritance diagram for CBioTreeContainer:

Collaboration diagram for CBioTreeContainer:

Public Member Functions
	CBioTreeContainer (void)

	~CBioTreeContainer (void)

size_t	GetNodeCount () const

size_t	GetLeafCount () const

Public Member Functions inherited from CBioTreeContainer_Base
	CBioTreeContainer_Base (void)

virtual	~CBioTreeContainer_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetTreetype (void) const
	hint on what kind of tree this is Check if a value has been assigned to Treetype data member. More...

bool	CanGetTreetype (void) const
	Check if it is safe to call GetTreetype method. More...

void	ResetTreetype (void)
	Reset Treetype data member. More...

const TTreetype &	GetTreetype (void) const
	Get the Treetype member data. More...

void	SetTreetype (const TTreetype &value)
	Assign a value to Treetype data member. More...

void	SetTreetype (TTreetype &&value)

TTreetype &	SetTreetype (void)
	Assign a value to Treetype data member. More...

bool	IsSetFdict (void) const
	features dictionary Check if a value has been assigned to Fdict data member. More...

bool	CanGetFdict (void) const
	Check if it is safe to call GetFdict method. More...

void	ResetFdict (void)
	Reset Fdict data member. More...

const TFdict &	GetFdict (void) const
	Get the Fdict member data. More...

void	SetFdict (TFdict &value)
	Assign a value to Fdict data member. More...

TFdict &	SetFdict (void)
	Assign a value to Fdict data member. More...

bool	IsSetNodes (void) const
	set of nodes with encoded topology Check if a value has been assigned to Nodes data member. More...

bool	CanGetNodes (void) const
	Check if it is safe to call GetNodes method. More...

void	ResetNodes (void)
	Reset Nodes data member. More...

const TNodes &	GetNodes (void) const
	Get the Nodes member data. More...

void	SetNodes (TNodes &value)
	Assign a value to Nodes data member. More...

TNodes &	SetNodes (void)
	Assign a value to Nodes data member. More...

bool	IsSetLabel (void) const
	bio-tree label (short name) Check if a value has been assigned to Label data member. More...

bool	CanGetLabel (void) const
	Check if it is safe to call GetLabel method. More...

void	ResetLabel (void)
	Reset Label data member. More...

const TLabel &	GetLabel (void) const
	Get the Label member data. More...

void	SetLabel (const TLabel &value)
	Assign a value to Label data member. More...

void	SetLabel (TLabel &&value)

TLabel &	SetLabel (void)
	Assign a value to Label data member. More...

bool	IsSetUser (void) const
	user defined object Check if a value has been assigned to User data member. More...

bool	CanGetUser (void) const
	Check if it is safe to call GetUser method. More...

void	ResetUser (void)
	Reset User data member. More...

const TUser &	GetUser (void) const
	Get the User member data. More...

void	SetUser (TUser &value)
	Assign a value to User data member. More...

TUser &	SetUser (void)
	Assign a value to User data member. More...

virtual void	Reset (void)
	Reset the whole object. More...

Public Member Functions inherited from CSerialObject
	CSerialObject (void)

virtual	~CSerialObject (void)

virtual const CTypeInfo *	GetThisTypeInfo (void) const =0

virtual void	Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
	Set object to copy of another one. More...

virtual bool	Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
	Check if both objects contain the same values. More...

virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...

void	ThrowUnassigned (TMemberIndex index) const

void	ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const

bool	HasNamespaceName (void) const
	Check if object data type has namespace name. More...

const string &	GetNamespaceName (void) const
	Get namespace name. More...

bool	HasNamespacePrefix (void) const
	Check if data type has namespace prefix. More...

const string &	GetNamespacePrefix (void) const
	Get namespace prefix. More...

Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...

	CObject (const CObject &src)
	Copy constructor. More...

virtual	~CObject (void)
	Destructor. More...

CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...

bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...

bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...

bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...

bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...

void	AddReference (void) const
	Add reference to object. More...

void	RemoveReference (void) const
	Remove reference to object. More...

void	ReleaseReference (void) const
	Remove reference without deleting object. More...

virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...

virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...

void *	operator new (size_t size)
	Define new operator for memory allocation. More...

void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...

void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...

void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...

void *	operator new (size_t size, void *place)
	Define new operator. More...

void	operator delete (void ptr, void place)
	Define delete operator. More...

void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...

void	operator delete (void ptr, CObjectMemoryPool place)
	Define delete operator. More...

Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)

virtual	~CDebugDumpable (void)

void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const

void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const

void	DumpToConsole (void) const

Private Types
typedef CBioTreeContainer_Base	Tparent

Private Member Functions
	CBioTreeContainer (const CBioTreeContainer &value)

CBioTreeContainer &	operator= (const CBioTreeContainer &value)

Additional Inherited Members
Public Types inherited from CBioTreeContainer_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_treetype , e_fdict , e_nodes , e_label , e_user }

typedef string	TTreetype

typedef CFeatureDictSet	TFdict

typedef CNodeSet	TNodes

typedef string	TLabel

typedef CUser_object	TUser

typedef Tparent::CMemberIndex< E_memberIndex, 6 >	TmemberIndex

Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...

typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...

typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Static Public Member Functions inherited from CSerialObject
static void	SetVerifyDataThread (ESerialVerifyData verify)

static void	SetVerifyDataGlobal (ESerialVerifyData verify)

static string	UnassignedString (void)

static CStringUTF8	UnassignedStringUTF8 (void)

static char	UnassignedByte (void)

Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...

static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)

static EAllocFillMode	GetAllocFillMode (void)

static void	SetAllocFillMode (EAllocFillMode mode)

static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...

Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Static Public Attributes inherited from CSerialObject
static const char *	ms_UnassignedStr = "<unassigned>"

static const char	ms_UnassignedByte = char(0xcd)

Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...

static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...

static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...

static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...

static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...

static const TCount	eCounterStateMask
	Valid object, and object in heap. More...

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Detailed Description

Definition at line 53 of file BioTreeContainer.hpp.

Member Typedef Documentation

◆ Tparent

typedef CBioTreeContainer_Base CBioTreeContainer::Tparent

private

Definition at line 55 of file BioTreeContainer.hpp.

Constructor & Destructor Documentation

◆ CBioTreeContainer() [1/2]

CBioTreeContainer::CBioTreeContainer ( void )

inline

Definition at line 76 of file BioTreeContainer.hpp.

◆ ~CBioTreeContainer()

CBioTreeContainer::~CBioTreeContainer ( void )

Definition at line 54 of file BioTreeContainer.cpp.

◆ CBioTreeContainer() [2/2]

CBioTreeContainer::CBioTreeContainer ( const CBioTreeContainer & value )

private

Member Function Documentation

◆ GetLeafCount()

size_t CBioTreeContainer::GetLeafCount ( void ) const

Definition at line 68 of file BioTreeContainer.cpp.

References set< Key, Compare >::erase(), Get(), CNode_Base::GetId(), CBioTreeContainer_Base::GetNodes(), CNode_Base::GetParent(), set< Key, Compare >::insert(), CBioTreeContainer_Base::IsSetNodes(), CNode_Base::IsSetParent(), ITERATE, and set< Key, Compare >::size().

◆ GetNodeCount()

size_t CBioTreeContainer::GetNodeCount ( ) const

Definition at line 59 of file BioTreeContainer.cpp.

References CNodeSet_Base::Get(), CBioTreeContainer_Base::GetNodes(), and CBioTreeContainer_Base::IsSetNodes().

◆ operator=()

CBioTreeContainer& CBioTreeContainer::operator= ( const CBioTreeContainer & value )

private

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

include/objects/biotree/BioTreeContainer.hpp
src/objects/biotree/BioTreeContainer.cpp

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CBioTreeContainer() [1/2]

◆ ~CBioTreeContainer()

◆ CBioTreeContainer() [2/2]

Member Function Documentation

◆ GetLeafCount()

◆ GetNodeCount()

◆ operator=()