NCBI C++ ToolKit
|
Search Toolkit Book for CPC_StereoTetrahedral_Base
SP3 Tetrahedral StereoCenter, Trigonal Pyramid Stereogenic Center, Cumulenic StereoCenter (Linear systems of an even number of double bonds), or Hindered biaryl stereocenter (All biaryls have hindered rotation that to some extent the ortho-hydrogens prevent coplanarity) [Using IUPAC Stereogenic Center recommendations and terminology] [Note: "-1" can be used for the Atom Identifier to represent a lone-pair or implicit hydrogen]. More...
#include <objects/pcsubstance/PC_StereoTetrahedral_.hpp>
Public Types | |
enum | EParity { eParity_clockwise = 1 , eParity_counterclockwise = 2 , eParity_any = 3 , eParity_unknown = 255 } |
StereoCenter Designation. More... | |
enum | EType { eType_tetrahedral = 1 , eType_cumulenic = 2 , eType_biaryl = 3 } |
Type of StereoCenter, Tetrahedral, if not specified. More... | |
enum class | E_memberIndex { e__allMandatory = 0 , e_center , e_above , e_top , e_bottom , e_below , e_parity , e_type } |
typedef int | TCenter |
typedef int | TAbove |
typedef int | TTop |
typedef int | TBottom |
typedef int | TBelow |
typedef int | TParity |
typedef int | TType |
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< Uint8 > | TCounter |
Counter type is CAtomiCounter. More... | |
typedef Uint8 | TCount |
Alias for value type of counter. More... | |
Public Member Functions | |
CPC_StereoTetrahedral_Base (void) | |
virtual | ~CPC_StereoTetrahedral_Base (void) |
DECLARE_INTERNAL_TYPE_INFO () | |
bool | IsSetCenter (void) const |
Atom Identifier of Atom Center Note: Atom ID's must be greater than "0" Check if a value has been assigned to Center data member. More... | |
bool | CanGetCenter (void) const |
Check if it is safe to call GetCenter method. More... | |
void | ResetCenter (void) |
Reset Center data member. More... | |
TCenter | GetCenter (void) const |
Get the Center member data. More... | |
void | SetCenter (TCenter value) |
Assign a value to Center data member. More... | |
TCenter & | SetCenter (void) |
Assign a value to Center data member. More... | |
bool | IsSetAbove (void) const |
Atom Identifier of Atom Above the Plane Note: Atom ID's must be greater than "0" Check if a value has been assigned to Above data member. More... | |
bool | CanGetAbove (void) const |
Check if it is safe to call GetAbove method. More... | |
void | ResetAbove (void) |
Reset Above data member. More... | |
TAbove | GetAbove (void) const |
Get the Above member data. More... | |
void | SetAbove (TAbove value) |
Assign a value to Above data member. More... | |
TAbove & | SetAbove (void) |
Assign a value to Above data member. More... | |
bool | IsSetTop (void) const |
Atom Identifier of Atom In-Plane and at the Top Note: Atom ID's must be greater than "0" Check if a value has been assigned to Top data member. More... | |
bool | CanGetTop (void) const |
Check if it is safe to call GetTop method. More... | |
void | ResetTop (void) |
Reset Top data member. More... | |
TTop | GetTop (void) const |
Get the Top member data. More... | |
void | SetTop (TTop value) |
Assign a value to Top data member. More... | |
TTop & | SetTop (void) |
Assign a value to Top data member. More... | |
bool | IsSetBottom (void) const |
Atom Identifier of Atom In-Plane and at the Bottom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Bottom data member. More... | |
bool | CanGetBottom (void) const |
Check if it is safe to call GetBottom method. More... | |
void | ResetBottom (void) |
Reset Bottom data member. More... | |
TBottom | GetBottom (void) const |
Get the Bottom member data. More... | |
void | SetBottom (TBottom value) |
Assign a value to Bottom data member. More... | |
TBottom & | SetBottom (void) |
Assign a value to Bottom data member. More... | |
bool | IsSetBelow (void) const |
Atom Identifier of Atom Below the Plane Note: Atom ID's must be greater than "0" Check if a value has been assigned to Below data member. More... | |
bool | CanGetBelow (void) const |
Check if it is safe to call GetBelow method. More... | |
void | ResetBelow (void) |
Reset Below data member. More... | |
TBelow | GetBelow (void) const |
Get the Below member data. More... | |
void | SetBelow (TBelow value) |
Assign a value to Below data member. More... | |
TBelow & | SetBelow (void) |
Assign a value to Below data member. More... | |
bool | IsSetParity (void) const |
Check if a value has been assigned to Parity data member. More... | |
bool | CanGetParity (void) const |
Check if it is safe to call GetParity method. More... | |
void | ResetParity (void) |
Reset Parity data member. More... | |
TParity | GetParity (void) const |
Get the Parity member data. More... | |
void | SetParity (TParity value) |
Assign a value to Parity data member. More... | |
TParity & | SetParity (void) |
Assign a value to Parity 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... | |
TType & | SetType (void) |
Assign a value to Type 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 |
Static Public Member Functions | |
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() | EParity (void) |
Access to EParity's attributes (values, names) as defined in spec. More... | |
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() | EType (void) |
Access to EType'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 | |
CPC_StereoTetrahedral_Base (const CPC_StereoTetrahedral_Base &) | |
CPC_StereoTetrahedral_Base & | operator= (const CPC_StereoTetrahedral_Base &) |
Private Attributes | |
Uint4 | m_set_State [1] |
int | m_Center |
int | m_Above |
int | m_Top |
int | m_Bottom |
int | m_Below |
int | m_Parity |
int | m_Type |
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... | |
SP3 Tetrahedral StereoCenter, Trigonal Pyramid Stereogenic Center, Cumulenic StereoCenter (Linear systems of an even number of double bonds), or Hindered biaryl stereocenter (All biaryls have hindered rotation that to some extent the ortho-hydrogens prevent coplanarity) [Using IUPAC Stereogenic Center recommendations and terminology] [Note: "-1" can be used for the Atom Identifier to represent a lone-pair or implicit hydrogen].
Definition at line 74 of file PC_StereoTetrahedral_.hpp.