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-StereoPlanar defined in file pcsubstance.asn

Search Toolkit Book for CPC_StereoPlanar_Base

SP2 Planar Stereogenic Center, Cumulenic StereoCenter (Linear systems on an odd number of double bonds present planar stereochemistry) [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_StereoPlanar_.hpp>

+ Inheritance diagram for CPC_StereoPlanar_Base:
+ Collaboration diagram for CPC_StereoPlanar_Base:

Public Types

enum  EParity { eParity_same = 1 , eParity_opposite = 2 , eParity_any = 3 , eParity_unknown = 255 }
 StereoCenter Designation. More...
 
enum  EType { eType_planar = 1 , eType_cumulenic = 2 }
 Type of StereoCenter, SP2 Planar, if not specified. More...
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_left , e_ltop , e_lbottom ,
  e_right , e_rtop , e_rbottom , e_parity ,
  e_type
}
 
typedef int TLeft
 
typedef int TLtop
 
typedef int TLbottom
 
typedef int TRight
 
typedef int TRtop
 
typedef int TRbottom
 
typedef int TParity
 
typedef int TType
 
typedef Tparent::CMemberIndex< E_memberIndex, 9 > 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_StereoPlanar_Base (void)
 
virtual ~CPC_StereoPlanar_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetLeft (void) const
 Atom ID of Left Double Bond Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Left data member. More...
 
bool CanGetLeft (void) const
 Check if it is safe to call GetLeft method. More...
 
void ResetLeft (void)
 Reset Left data member. More...
 
TLeft GetLeft (void) const
 Get the Left member data. More...
 
void SetLeft (TLeft value)
 Assign a value to Left data member. More...
 
TLeftSetLeft (void)
 Assign a value to Left data member. More...
 
bool IsSetLtop (void) const
 Atom ID of Top Atom attached to the Left Double Bond Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Ltop data member. More...
 
bool CanGetLtop (void) const
 Check if it is safe to call GetLtop method. More...
 
void ResetLtop (void)
 Reset Ltop data member. More...
 
TLtop GetLtop (void) const
 Get the Ltop member data. More...
 
void SetLtop (TLtop value)
 Assign a value to Ltop data member. More...
 
TLtopSetLtop (void)
 Assign a value to Ltop data member. More...
 
bool IsSetLbottom (void) const
 Atom ID of Bottom Atom attached to the Left Double Bond Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Lbottom data member. More...
 
bool CanGetLbottom (void) const
 Check if it is safe to call GetLbottom method. More...
 
void ResetLbottom (void)
 Reset Lbottom data member. More...
 
TLbottom GetLbottom (void) const
 Get the Lbottom member data. More...
 
void SetLbottom (TLbottom value)
 Assign a value to Lbottom data member. More...
 
TLbottomSetLbottom (void)
 Assign a value to Lbottom data member. More...
 
bool IsSetRight (void) const
 Atom ID of Right Double Bond Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Right data member. More...
 
bool CanGetRight (void) const
 Check if it is safe to call GetRight method. More...
 
void ResetRight (void)
 Reset Right data member. More...
 
TRight GetRight (void) const
 Get the Right member data. More...
 
void SetRight (TRight value)
 Assign a value to Right data member. More...
 
TRightSetRight (void)
 Assign a value to Right data member. More...
 
bool IsSetRtop (void) const
 Atom ID of Top Atom attached to the Right Double Bond Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Rtop data member. More...
 
bool CanGetRtop (void) const
 Check if it is safe to call GetRtop method. More...
 
void ResetRtop (void)
 Reset Rtop data member. More...
 
TRtop GetRtop (void) const
 Get the Rtop member data. More...
 
void SetRtop (TRtop value)
 Assign a value to Rtop data member. More...
 
TRtopSetRtop (void)
 Assign a value to Rtop data member. More...
 
bool IsSetRbottom (void) const
 Atom ID of Bottom Atom attached to the Right Double Bond Atom Note: Atom ID's must be greater than "0" Check if a value has been assigned to Rbottom data member. More...
 
bool CanGetRbottom (void) const
 Check if it is safe to call GetRbottom method. More...
 
void ResetRbottom (void)
 Reset Rbottom data member. More...
 
TRbottom GetRbottom (void) const
 Get the Rbottom member data. More...
 
void SetRbottom (TRbottom value)
 Assign a value to Rbottom data member. More...
 
TRbottomSetRbottom (void)
 Assign a value to Rbottom 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...
 
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...
 
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 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_StereoPlanar_Base (const CPC_StereoPlanar_Base &)
 
CPC_StereoPlanar_Baseoperator= (const CPC_StereoPlanar_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Left
 
int m_Ltop
 
int m_Lbottom
 
int m_Right
 
int m_Rtop
 
int m_Rbottom
 
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...
 

Detailed Description

SP2 Planar Stereogenic Center, Cumulenic StereoCenter (Linear systems on an odd number of double bonds present planar stereochemistry) [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_StereoPlanar_Base

Definition at line 72 of file PC_StereoPlanar_.hpp.


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