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

Represents ASN.1 type PC-StereoSquarePlanar defined in file pcsubstance.asn

Search Toolkit Book for CPC_StereoSquarePlanar_Base

Square Planar (SP4) StereoCenters [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_StereoSquarePlanar_.hpp>

+ Inheritance diagram for CPC_StereoSquarePlanar_Base:
+ Collaboration diagram for CPC_StereoSquarePlanar_Base:

Public Types

enum  EParity {
  eParity_u_shape = 1 , eParity_z_shape = 2 , eParity_x_shape = 3 , eParity_any = 4 ,
  eParity_unknown = 255
}
 StereoCenter Type. More...
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_center , e_lbelow , e_rbelow ,
  e_labove , e_rabove , e_parity
}
 
typedef int TCenter
 
typedef int TLbelow
 
typedef int TRbelow
 
typedef int TLabove
 
typedef int TRabove
 
typedef int TParity
 
typedef Tparent::CMemberIndex< E_memberIndex, 7 > 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

 CPC_StereoSquarePlanar_Base (void)
 
virtual ~CPC_StereoSquarePlanar_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetCenter (void) const
 Atom ID 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...
 
TCenterSetCenter (void)
 Assign a value to Center data member. More...
 
bool IsSetLbelow (void) const
 Atom ID of Left Below Plane Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Lbelow data member. More...
 
bool CanGetLbelow (void) const
 Check if it is safe to call GetLbelow method. More...
 
void ResetLbelow (void)
 Reset Lbelow data member. More...
 
TLbelow GetLbelow (void) const
 Get the Lbelow member data. More...
 
void SetLbelow (TLbelow value)
 Assign a value to Lbelow data member. More...
 
TLbelowSetLbelow (void)
 Assign a value to Lbelow data member. More...
 
bool IsSetRbelow (void) const
 Atom ID of Right Below Plane Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Rbelow data member. More...
 
bool CanGetRbelow (void) const
 Check if it is safe to call GetRbelow method. More...
 
void ResetRbelow (void)
 Reset Rbelow data member. More...
 
TRbelow GetRbelow (void) const
 Get the Rbelow member data. More...
 
void SetRbelow (TRbelow value)
 Assign a value to Rbelow data member. More...
 
TRbelowSetRbelow (void)
 Assign a value to Rbelow data member. More...
 
bool IsSetLabove (void) const
 Atom ID of Left Above Plane Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Labove data member. More...
 
bool CanGetLabove (void) const
 Check if it is safe to call GetLabove method. More...
 
void ResetLabove (void)
 Reset Labove data member. More...
 
TLabove GetLabove (void) const
 Get the Labove member data. More...
 
void SetLabove (TLabove value)
 Assign a value to Labove data member. More...
 
TLaboveSetLabove (void)
 Assign a value to Labove data member. More...
 
bool IsSetRabove (void) const
 Atom ID of Right Above Plane Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Rabove data member. More...
 
bool CanGetRabove (void) const
 Check if it is safe to call GetRabove method. More...
 
void ResetRabove (void)
 Reset Rabove data member. More...
 
TRabove GetRabove (void) const
 Get the Rabove member data. More...
 
void SetRabove (TRabove value)
 Assign a value to Rabove data member. More...
 
TRaboveSetRabove (void)
 Assign a value to Rabove 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...
 
TParitySetParity (void)
 Assign a value to Parity 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() EParity (void)
 Access to EParity'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_StereoSquarePlanar_Base (const CPC_StereoSquarePlanar_Base &)
 
CPC_StereoSquarePlanar_Baseoperator= (const CPC_StereoSquarePlanar_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Center
 
int m_Lbelow
 
int m_Rbelow
 
int m_Labove
 
int m_Rabove
 
int m_Parity
 

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

Square Planar (SP4) StereoCenters [Using IUPAC Stereogenic Center recommendations and terminology] [Note: "-1" can be used for the Atom Identifier to represent a lone-pair or implicit hydrogen].

CPC_StereoSquarePlanar_Base

Definition at line 71 of file PC_StereoSquarePlanar_.hpp.


The documentation for this class was generated from the following files:
Modified on Sat May 18 11:36:24 2024 by modify_doxy.py rev. 669887