Search Toolkit Book for CCn3d_user_annotation
CCn3d_user_annotation –. More...
#include <objects/cn3d/Cn3d_user_annotation.hpp>
Inheritance diagram for CCn3d_user_annotation:
Collaboration diagram for CCn3d_user_annotation:
Public Member Functions | |
| CCn3d_user_annotation (void) | |
| ~CCn3d_user_annotation (void) | |
| Public Member Functions inherited from CCn3d_user_annotation_Base | |
| CCn3d_user_annotation_Base (void) | |
| virtual | ~CCn3d_user_annotation_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetName (void) const |
| a (short) name for this annotation 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 TName & | GetName (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) |
| TName & | SetName (void) |
| Assign a value to Name data member. More... | |
| bool | IsSetDescription (void) const |
| an optional longer 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 | IsSetStyle_id (void) const |
| how to draw this annotation Check if a value has been assigned to Style_id data member. More... | |
| bool | CanGetStyle_id (void) const |
| Check if it is safe to call GetStyle_id method. More... | |
| void | ResetStyle_id (void) |
| Reset Style_id data member. More... | |
| const TStyle_id & | GetStyle_id (void) const |
| Get the Style_id member data. More... | |
| void | SetStyle_id (const TStyle_id &value) |
| Assign a value to Style_id data member. More... | |
| TStyle_id & | SetStyle_id (void) |
| Assign a value to Style_id data member. More... | |
| bool | IsSetResidues (void) const |
| which residues to cover Check if a value has been assigned to Residues data member. More... | |
| bool | CanGetResidues (void) const |
| Check if it is safe to call GetResidues method. More... | |
| void | ResetResidues (void) |
| Reset Residues data member. More... | |
| const TResidues & | GetResidues (void) const |
| Get the Residues member data. More... | |
| TResidues & | SetResidues (void) |
| Assign a value to Residues data member. More... | |
| bool | IsSetIs_on (void) const |
| whether this annotation is to be turned on in Cn3D Check if a value has been assigned to Is_on data member. More... | |
| bool | CanGetIs_on (void) const |
| Check if it is safe to call GetIs_on method. More... | |
| void | ResetIs_on (void) |
| Reset Is_on data member. More... | |
| TIs_on | GetIs_on (void) const |
| Get the Is_on member data. More... | |
| void | SetIs_on (TIs_on value) |
| Assign a value to Is_on data member. More... | |
| TIs_on & | SetIs_on (void) |
| Assign a value to Is_on 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 CCn3d_user_annotation_Base | Tparent |
Private Member Functions | |
| CCn3d_user_annotation (const CCn3d_user_annotation &value) | |
| CCn3d_user_annotation & | operator= (const CCn3d_user_annotation &value) |
Additional Inherited Members | |
| Public Types inherited from CCn3d_user_annotation_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_name , e_description , e_style_id , e_residues , e_is_on } |
| typedef string | TName |
| typedef string | TDescription |
| typedef CCn3d_style_table_id | TStyle_id |
| typedef list< CRef< CCn3d_object_location > > | TResidues |
| typedef bool | TIs_on |
| 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 65 of file Cn3d_user_annotation.hpp.
The documentation for this class was generated from the following files:
- include/objects/cn3d/Cn3d_user_annotation.hpp
- src/objects/cn3d/Cn3d_user_annotation.cpp
