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

Search Toolkit Book for CCn3d_backbone_label_style_Base

style blob for backbone labels More...

#include <objects/cn3d/Cn3d_backbone_label_style_.hpp>

+ Inheritance diagram for CCn3d_backbone_label_style_Base:
+ Collaboration diagram for CCn3d_backbone_label_style_Base:

Public Types

enum  EType { eType_one_letter = 1 , eType_three_letter = 2 }
 
enum  ENumber { eNumber_none = 0 , eNumber_sequential = 1 , eNumber_pdb = 2 }
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_spacing , e_type , e_number ,
  e_termini , e_white
}
 
typedef int TSpacing
 
typedef EType TType
 
typedef ENumber TNumber
 
typedef bool TTermini
 
typedef bool TWhite
 
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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CCn3d_backbone_label_style_Base (void)
 
virtual ~CCn3d_backbone_label_style_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetSpacing (void) const
 zero means none Check if a value has been assigned to Spacing data member. More...
 
bool CanGetSpacing (void) const
 Check if it is safe to call GetSpacing method. More...
 
void ResetSpacing (void)
 Reset Spacing data member. More...
 
TSpacing GetSpacing (void) const
 Get the Spacing member data. More...
 
void SetSpacing (TSpacing value)
 Assign a value to Spacing data member. More...
 
TSpacingSetSpacing (void)
 Assign a value to Spacing data member. More...
 
bool IsSetType (void) const
 Check if a value has been assigned to Type data member. More...
 
bool CanGetType (void) const
 Check if it is safe to call GetType method. More...
 
void ResetType (void)
 Reset Type data member. More...
 
TType GetType (void) const
 Get the Type member data. More...
 
void SetType (TType value)
 Assign a value to Type data member. More...
 
TTypeSetType (void)
 Assign a value to Type data member. More...
 
bool IsSetNumber (void) const
 Check if a value has been assigned to Number data member. More...
 
bool CanGetNumber (void) const
 Check if it is safe to call GetNumber method. More...
 
void ResetNumber (void)
 Reset Number data member. More...
 
TNumber GetNumber (void) const
 Get the Number member data. More...
 
void SetNumber (TNumber value)
 Assign a value to Number data member. More...
 
TNumberSetNumber (void)
 Assign a value to Number data member. More...
 
bool IsSetTermini (void) const
 Check if a value has been assigned to Termini data member. More...
 
bool CanGetTermini (void) const
 Check if it is safe to call GetTermini method. More...
 
void ResetTermini (void)
 Reset Termini data member. More...
 
TTermini GetTermini (void) const
 Get the Termini member data. More...
 
void SetTermini (TTermini value)
 Assign a value to Termini data member. More...
 
TTerminiSetTermini (void)
 Assign a value to Termini data member. More...
 
bool IsSetWhite (void) const
 all white, or (if false) color of alpha carbon Check if a value has been assigned to White data member. More...
 
bool CanGetWhite (void) const
 Check if it is safe to call GetWhite method. More...
 
void ResetWhite (void)
 Reset White data member. More...
 
TWhite GetWhite (void) const
 Get the White member data. More...
 
void SetWhite (TWhite value)
 Assign a value to White data member. More...
 
TWhiteSetWhite (void)
 Assign a value to White 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
 

Static Public Member Functions

static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EType (void)
 Access to EType's attributes (values, names) as defined in spec. More...
 
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ENumber (void)
 Access to ENumber's attributes (values, names) as defined in spec. 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

 CCn3d_backbone_label_style_Base (const CCn3d_backbone_label_style_Base &)
 
CCn3d_backbone_label_style_Baseoperator= (const CCn3d_backbone_label_style_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Spacing
 
EType m_Type
 
ENumber m_Number
 
bool m_Termini
 
bool m_White
 

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

style blob for backbone labels

CCn3d_backbone_label_style_Base

Definition at line 69 of file Cn3d_backbone_label_style_.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:58:08 2024 by modify_doxy.py rev. 669887