Search Toolkit Book for CUpdate_comment_Base
Update-align is supposed to contain alignments that still need some work done to fit into the CD-proper alignment. More...
#include <objects/cdd/Update_comment_.hpp>
Inheritance diagram for CUpdate_comment_Base:
Collaboration diagram for CUpdate_comment_Base:
Public Types | |
| enum | E_Choice { e_not_set = 0 , e_Comment , e_Addthis , e_Replaces , e_Reject_loc , e_Reference } |
| Choice variants. More... | |
| enum | E_ChoiceStopper { e_MaxChoice = 6 } |
| Maximum+1 value of the choice variant enumerator. More... | |
| typedef string | TComment |
| typedef CSeq_loc | TAddthis |
| typedef CSeq_loc | TReplaces |
| typedef CSeq_loc | TReject_loc |
| typedef CPub | TReference |
| 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... | |
Public Member Functions | |
| CUpdate_comment_Base (void) | |
| virtual | ~CUpdate_comment_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| virtual void | Reset (void) |
| Reset the whole object. More... | |
| virtual void | ResetSelection (void) |
| Reset the selection (set it to e_not_set). More... | |
| E_Choice | Which (void) const |
| Which variant is currently selected. More... | |
| void | CheckSelected (E_Choice index) const |
| Verify selection, throw exception if it differs from the expected. More... | |
| void | ThrowInvalidSelection (E_Choice index) const |
| Throw 'InvalidSelection' exception. More... | |
| void | Select (E_Choice index, EResetVariant reset=eDoResetVariant) |
| Select the requested variant if needed. More... | |
| void | Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool) |
| Select the requested variant if needed, allocating CObject variants from memory pool. More... | |
| bool | IsComment (void) const |
| Check if variant Comment is selected. More... | |
| const TComment & | GetComment (void) const |
| Get the variant data. More... | |
| TComment & | SetComment (void) |
| Select the variant. More... | |
| void | SetComment (const TComment &value) |
| Select the variant and set its data. More... | |
| bool | IsAddthis (void) const |
| Check if variant Addthis is selected. More... | |
| const TAddthis & | GetAddthis (void) const |
| Get the variant data. More... | |
| TAddthis & | SetAddthis (void) |
| Select the variant. More... | |
| void | SetAddthis (TAddthis &value) |
| Select the variant and set its data. More... | |
| bool | IsReplaces (void) const |
| Check if variant Replaces is selected. More... | |
| const TReplaces & | GetReplaces (void) const |
| Get the variant data. More... | |
| TReplaces & | SetReplaces (void) |
| Select the variant. More... | |
| void | SetReplaces (TReplaces &value) |
| Select the variant and set its data. More... | |
| bool | IsReject_loc (void) const |
| Check if variant Reject_loc is selected. More... | |
| const TReject_loc & | GetReject_loc (void) const |
| Get the variant data. More... | |
| TReject_loc & | SetReject_loc (void) |
| Select the variant. More... | |
| void | SetReject_loc (TReject_loc &value) |
| Select the variant and set its data. More... | |
| bool | IsReference (void) const |
| Check if variant Reference is selected. More... | |
| const TReference & | GetReference (void) const |
| Get the variant data. More... | |
| TReference & | SetReference (void) |
| Select the variant. More... | |
| void | SetReference (TReference &value) |
| Select the variant and set its data. 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 |
Static Public Member Functions | |
| static string | SelectionName (E_Choice index) |
| Retrieve selection name (for diagnostic purposes). 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) |
Private Types | |
| typedef CSerialObject | Tparent |
Private Member Functions | |
| CUpdate_comment_Base (const CUpdate_comment_Base &) | |
| CUpdate_comment_Base & | operator= (const CUpdate_comment_Base &) |
| void | DoSelect (E_Choice index, CObjectMemoryPool *pool=0) |
Private Attributes | |
| E_Choice | m_choice |
| union { | |
| NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string > CUpdate_comment_Base::m_string | |
| NCBI_NS_NCBI::CSerialObject * CUpdate_comment_Base::m_object | |
| }; | |
Static Private Attributes | |
| static const char *const | sm_SelectionNames [] |
Additional Inherited Members | |
| 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
Update-align is supposed to contain alignments that still need some work done to fit into the CD-proper alignment.
These originate from the CD update process (generated by Blast, for example) or may be created in an editing session to save its state
Definition at line 81 of file Update_comment_.hpp.
The documentation for this class was generated from the following files:
- include/objects/cdd/Update_comment_.hpp
- src/objects/cdd/Update_comment_.cpp
