NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members

Represents ASN.1 type Cdd-tree defined in file cdd.asn

Search Toolkit Book for CCdd_tree_Base

the Cdd-tree stores the hierarchy of CDDs. More...

#include <objects/cdd/Cdd_tree_.hpp>

+ Inheritance diagram for CCdd_tree_Base:
+ Collaboration diagram for CCdd_tree_Base:

Public Types

enum class  E_memberIndex {
  e__allMandatory = 0 , e_name , e_id , e_description ,
  e_parent , e_children , e_siblings , e_neighbors
}
 
typedef string TName
 
typedef CCdd_id_set TId
 
typedef CCdd_descr_set TDescription
 
typedef CCdd_id TParent
 
typedef CCdd_id_set TChildren
 
typedef CCdd_id_set TSiblings
 
typedef CCdd_id_set TNeighbors
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CCdd_tree_Base (void)
 
virtual ~CCdd_tree_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetName (void) const
 short name copied from CD Check if a value has been assigned to Name data member. More...
 
bool CanGetName (void) const
 Check if it is safe to call GetName method. More...
 
void ResetName (void)
 Reset Name data member. More...
 
const TNameGetName (void) const
 Get the Name member data. More...
 
void SetName (const TName &value)
 Assign a value to Name data member. More...
 
void SetName (TName &&value)
 
TNameSetName (void)
 Assign a value to Name data member. More...
 
bool IsSetId (void) const
 IDs copied from CD Check if a value has been assigned to Id data member. More...
 
bool CanGetId (void) const
 Check if it is safe to call GetId method. More...
 
void ResetId (void)
 Reset Id data member. More...
 
const TIdGetId (void) const
 Get the Id member data. More...
 
void SetId (TId &value)
 Assign a value to Id data member. More...
 
TIdSetId (void)
 Assign a value to Id data member. More...
 
bool IsSetDescription (void) const
 description copied from CD Check if a value has been assigned to Description data member. More...
 
bool CanGetDescription (void) const
 Check if it is safe to call GetDescription method. More...
 
void ResetDescription (void)
 Reset Description data member. More...
 
const TDescriptionGetDescription (void) const
 Get the Description member data. More...
 
void SetDescription (TDescription &value)
 Assign a value to Description data member. More...
 
TDescriptionSetDescription (void)
 Assign a value to Description data member. More...
 
bool IsSetParent (void) const
 CD is the result of a split/merge Check if a value has been assigned to Parent data member. More...
 
bool CanGetParent (void) const
 Check if it is safe to call GetParent method. More...
 
void ResetParent (void)
 Reset Parent data member. More...
 
const TParentGetParent (void) const
 Get the Parent member data. More...
 
void SetParent (TParent &value)
 Assign a value to Parent data member. More...
 
TParentSetParent (void)
 Assign a value to Parent data member. More...
 
bool IsSetChildren (void) const
 this CD has been split Check if a value has been assigned to Children data member. More...
 
bool CanGetChildren (void) const
 Check if it is safe to call GetChildren method. More...
 
void ResetChildren (void)
 Reset Children data member. More...
 
const TChildrenGetChildren (void) const
 Get the Children member data. More...
 
void SetChildren (TChildren &value)
 Assign a value to Children data member. More...
 
TChildrenSetChildren (void)
 Assign a value to Children data member. More...
 
bool IsSetSiblings (void) const
 related CDs (have common hits) Check if a value has been assigned to Siblings data member. More...
 
bool CanGetSiblings (void) const
 Check if it is safe to call GetSiblings method. More...
 
void ResetSiblings (void)
 Reset Siblings data member. More...
 
const TSiblingsGetSiblings (void) const
 Get the Siblings member data. More...
 
void SetSiblings (TSiblings &value)
 Assign a value to Siblings data member. More...
 
TSiblingsSetSiblings (void)
 Assign a value to Siblings data member. More...
 
bool IsSetNeighbors (void) const
 co-occurring CDs (non-overlapping hits to same sequences) Check if a value has been assigned to Neighbors data member. More...
 
bool CanGetNeighbors (void) const
 Check if it is safe to call GetNeighbors method. More...
 
void ResetNeighbors (void)
 Reset Neighbors data member. More...
 
const TNeighborsGetNeighbors (void) const
 Get the Neighbors member data. More...
 
void SetNeighbors (TNeighbors &value)
 Assign a value to Neighbors data member. More...
 
TNeighborsSetNeighbors (void)
 Assign a value to Neighbors 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 CTypeInfoGetThisTypeInfo (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 stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (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...
 
CObjectoperator= (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 CSerialObject Tparent
 

Private Member Functions

 CCdd_tree_Base (const CCdd_tree_Base &)
 
CCdd_tree_Baseoperator= (const CCdd_tree_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
string m_Name
 
CRef< TIdm_Id
 
CRef< TDescriptionm_Description
 
CRef< TParentm_Parent
 
CRef< TChildrenm_Children
 
CRef< TSiblingsm_Siblings
 
CRef< TNeighborsm_Neighbors
 

Additional Inherited Members

- 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

the Cdd-tree stores the hierarchy of CDDs.

These objects are stored separate from the CDs to allow for fast retrieval and use as an 'index' into CDs all the components in a CD-tree match components in the full-sized CD and should be synchronized

CCdd_tree_Base

Definition at line 82 of file Cdd_tree_.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Jun 13 17:26:54 2024 by modify_doxy.py rev. 669887