|
NCBI C++ ToolKit
|
Search Toolkit Book for CHG_Commentary
#include <objects/homologene/HG_Commentary.hpp>
Inheritance diagram for CHG_Commentary:
Collaboration diagram for CHG_Commentary:Public Member Functions | |
| CHG_Commentary (void) | |
| ~CHG_Commentary (void) | |
Public Member Functions inherited from CHG_Commentary_Base | |
| CHG_Commentary_Base (void) | |
| virtual | ~CHG_Commentary_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetLink (void) const |
| Check if a value has been assigned to Link data member. More... | |
| bool | CanGetLink (void) const |
| Check if it is safe to call GetLink method. More... | |
| void | ResetLink (void) |
| Reset Link data member. More... | |
| const TLink & | GetLink (void) const |
| Get the Link member data. More... | |
| void | SetLink (TLink &value) |
| Assign a value to Link data member. More... | |
| TLink & | SetLink (void) |
| Assign a value to Link data member. More... | |
| bool | IsSetDescription (void) const |
| main description 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 TDescription & | GetDescription (void) const |
| Get the Description member data. More... | |
| void | SetDescription (const TDescription &value) |
| Assign a value to Description data member. More... | |
| void | SetDescription (TDescription &&value) |
| TDescription & | SetDescription (void) |
| Assign a value to Description data member. More... | |
| bool | IsSetCaption (void) const |
| extra text Check if a value has been assigned to Caption data member. More... | |
| bool | CanGetCaption (void) const |
| Check if it is safe to call GetCaption method. More... | |
| void | ResetCaption (void) |
| Reset Caption data member. More... | |
| const TCaption & | GetCaption (void) const |
| Get the Caption member data. More... | |
| void | SetCaption (const TCaption &value) |
| Assign a value to Caption data member. More... | |
| void | SetCaption (TCaption &&value) |
| TCaption & | SetCaption (void) |
| Assign a value to Caption data member. More... | |
| bool | IsSetProvider (void) const |
| Check if a value has been assigned to Provider data member. More... | |
| bool | CanGetProvider (void) const |
| Check if it is safe to call GetProvider method. More... | |
| void | ResetProvider (void) |
| Reset Provider data member. More... | |
| const TProvider & | GetProvider (void) const |
| Get the Provider member data. More... | |
| void | SetProvider (const TProvider &value) |
| Assign a value to Provider data member. More... | |
| void | SetProvider (TProvider &&value) |
| TProvider & | SetProvider (void) |
| Assign a value to Provider data member. More... | |
| bool | IsSetOther_links (void) const |
| Check if a value has been assigned to Other_links data member. More... | |
| bool | CanGetOther_links (void) const |
| Check if it is safe to call GetOther_links method. More... | |
| void | ResetOther_links (void) |
| Reset Other_links data member. More... | |
| const TOther_links & | GetOther_links (void) const |
| Get the Other_links member data. More... | |
| TOther_links & | SetOther_links (void) |
| Assign a value to Other_links data member. More... | |
| bool | IsSetOther_commentaries (void) const |
| Check if a value has been assigned to Other_commentaries data member. More... | |
| bool | CanGetOther_commentaries (void) const |
| Check if it is safe to call GetOther_commentaries method. More... | |
| void | ResetOther_commentaries (void) |
| Reset Other_commentaries data member. More... | |
| const TOther_commentaries & | GetOther_commentaries (void) const |
| Get the Other_commentaries member data. More... | |
| TOther_commentaries & | SetOther_commentaries (void) |
| Assign a value to Other_commentaries data member. More... | |
| bool | IsSetTaxid (void) const |
| Check if a value has been assigned to Taxid data member. More... | |
| bool | CanGetTaxid (void) const |
| Check if it is safe to call GetTaxid method. More... | |
| void | ResetTaxid (void) |
| Reset Taxid data member. More... | |
| TTaxid | GetTaxid (void) const |
| Get the Taxid member data. More... | |
| void | SetTaxid (TTaxid value) |
| Assign a value to Taxid data member. More... | |
| TTaxid & | SetTaxid (void) |
| Assign a value to Taxid data member. More... | |
| bool | IsSetGeneid (void) const |
| Check if a value has been assigned to Geneid data member. More... | |
| bool | CanGetGeneid (void) const |
| Check if it is safe to call GetGeneid method. More... | |
| void | ResetGeneid (void) |
| Reset Geneid data member. More... | |
| TGeneid | GetGeneid (void) const |
| Get the Geneid member data. More... | |
| void | SetGeneid (TGeneid value) |
| Assign a value to Geneid data member. More... | |
| TGeneid & | SetGeneid (void) |
| Assign a value to Geneid 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 CHG_Commentary_Base | Tparent |
Private Member Functions | |
| CHG_Commentary (const CHG_Commentary &value) | |
| CHG_Commentary & | operator= (const CHG_Commentary &value) |
Additional Inherited Members | |
Public Types inherited from CHG_Commentary_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_link , e_description , e_caption , e_provider , e_other_links , e_other_commentaries , e_taxid , e_geneid } |
| typedef CHG_Link | TLink |
| typedef string | TDescription |
| typedef string | TCaption |
| typedef string | TProvider |
| typedef list< CRef< CHG_Link > > | TOther_links |
| typedef list< CRef< CHG_Commentary > > | TOther_commentaries |
| typedef int | TTaxid |
| typedef int | TGeneid |
| typedef Tparent::CMemberIndex< E_memberIndex, 9 > | 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... | |
Definition at line 65 of file HG_Commentary.hpp.