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

Search Toolkit Book for CPC_Compound_Base

#include <objects/pcsubstance/PC_Compound_.hpp>

Inheritance diagram for CPC_Compound_Base:

Collaboration diagram for CPC_Compound_Base:

Public Types
enum class	E_memberIndex { e__allMandatory = 0 , e_id , e_atoms , e_bonds , e_stereo , e_coords , e_charge , e_props , e_stereogroups , e_count , e_vbalt , e_groups }

typedef CPC_CompoundType	TId

typedef CPC_Atoms	TAtoms

typedef CPC_Bonds	TBonds

typedef list< CRef< CPC_StereoCenter > >	TStereo

typedef list< CRef< CPC_Coordinates > >	TCoords

typedef int	TCharge

typedef list< CRef< CPC_InfoData > >	TProps

typedef list< CRef< CPC_StereoGroup > >	TStereogroups

typedef CPC_Count	TCount

typedef CPC_Compounds	TVbalt

typedef list< CRef< CPC_Group > >	TGroups

typedef Tparent::CMemberIndex< E_memberIndex, 12 >	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_Compound_Base (void)

virtual	~CPC_Compound_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetId (void) const
	Tracking Information Compound Qualifier (Type/ID) Check if a value has been assigned to Id data member. More...

bool	CanGetId (void) const
	Check if it is safe to call GetId method. More...

void	ResetId (void)
	Reset Id data member. More...

const TId &	GetId (void) const
	Get the Id member data. More...

void	SetId (TId &value)
	Assign a value to Id data member. More...

TId &	SetId (void)
	Assign a value to Id data member. More...

bool	IsSetAtoms (void) const
	AtomID/Type Information Check if a value has been assigned to Atoms data member. More...

bool	CanGetAtoms (void) const
	Check if it is safe to call GetAtoms method. More...

void	ResetAtoms (void)
	Reset Atoms data member. More...

const TAtoms &	GetAtoms (void) const
	Get the Atoms member data. More...

void	SetAtoms (TAtoms &value)
	Assign a value to Atoms data member. More...

TAtoms &	SetAtoms (void)
	Assign a value to Atoms data member. More...

bool	IsSetBonds (void) const
	BondID/Type/Atom Information Check if a value has been assigned to Bonds data member. More...

bool	CanGetBonds (void) const
	Check if it is safe to call GetBonds method. More...

void	ResetBonds (void)
	Reset Bonds data member. More...

const TBonds &	GetBonds (void) const
	Get the Bonds member data. More...

void	SetBonds (TBonds &value)
	Assign a value to Bonds data member. More...

TBonds &	SetBonds (void)
	Assign a value to Bonds data member. More...

bool	IsSetStereo (void) const
	StereoCenter Descriptions Check if a value has been assigned to Stereo data member. More...

bool	CanGetStereo (void) const
	Check if it is safe to call GetStereo method. More...

void	ResetStereo (void)
	Reset Stereo data member. More...

const TStereo &	GetStereo (void) const
	Get the Stereo member data. More...

TStereo &	SetStereo (void)
	Assign a value to Stereo data member. More...

bool	IsSetCoords (void) const
	2D/3D Coordinate Sets of Compound Check if a value has been assigned to Coords data member. More...

bool	CanGetCoords (void) const
	Check if it is safe to call GetCoords method. More...

void	ResetCoords (void)
	Reset Coords data member. More...

const TCoords &	GetCoords (void) const
	Get the Coords member data. More...

TCoords &	SetCoords (void)
	Assign a value to Coords data member. More...

bool	IsSetCharge (void) const
	Provided Total Formal Charge (Signed Integer) Check if a value has been assigned to Charge data member. More...

bool	CanGetCharge (void) const
	Check if it is safe to call GetCharge method. More...

void	ResetCharge (void)
	Reset Charge data member. More...

TCharge	GetCharge (void) const
	Get the Charge member data. More...

void	SetCharge (TCharge value)
	Assign a value to Charge data member. More...

TCharge &	SetCharge (void)
	Assign a value to Charge data member. More...

bool	IsSetProps (void) const
	Derived (computed) Properties Check if a value has been assigned to Props data member. More...

bool	CanGetProps (void) const
	Check if it is safe to call GetProps method. More...

void	ResetProps (void)
	Reset Props data member. More...

const TProps &	GetProps (void) const
	Get the Props member data. More...

TProps &	SetProps (void)
	Assign a value to Props data member. More...

bool	IsSetStereogroups (void) const
	Relative stereochemistry groups Check if a value has been assigned to Stereogroups data member. More...

bool	CanGetStereogroups (void) const
	Check if it is safe to call GetStereogroups method. More...

void	ResetStereogroups (void)
	Reset Stereogroups data member. More...

const TStereogroups &	GetStereogroups (void) const
	Get the Stereogroups member data. More...

TStereogroups &	SetStereogroups (void)
	Assign a value to Stereogroups data member. More...

bool	IsSetCount (void) const
	Counts of various properties Check if a value has been assigned to Count data member. More...

bool	CanGetCount (void) const
	Check if it is safe to call GetCount method. More...

void	ResetCount (void)
	Reset Count data member. More...

const TCount &	GetCount (void) const
	Get the Count member data. More...

void	SetCount (TCount &value)
	Assign a value to Count data member. More...

TCount &	SetCount (void)
	Assign a value to Count data member. More...

bool	IsSetVbalt (void) const
	Alternate Valence-Bond Forms Check if a value has been assigned to Vbalt data member. More...

bool	CanGetVbalt (void) const
	Check if it is safe to call GetVbalt method. More...

void	ResetVbalt (void)
	Reset Vbalt data member. More...

const TVbalt &	GetVbalt (void) const
	Get the Vbalt member data. More...

void	SetVbalt (TVbalt &value)
	Assign a value to Vbalt data member. More...

TVbalt &	SetVbalt (void)
	Assign a value to Vbalt data member. More...

bool	IsSetGroups (void) const
	Superatom groups Check if a value has been assigned to Groups data member. More...

bool	CanGetGroups (void) const
	Check if it is safe to call GetGroups method. More...

void	ResetGroups (void)
	Reset Groups data member. More...

const TGroups &	GetGroups (void) const
	Get the Groups member data. More...

TGroups &	SetGroups (void)
	Assign a value to Groups 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 CSerialObject	Tparent

Private Member Functions
	CPC_Compound_Base (const CPC_Compound_Base &)

CPC_Compound_Base &	operator= (const CPC_Compound_Base &)

Private Attributes
Uint4	m_set_State [1]

CRef< TId >	m_Id

CRef< TAtoms >	m_Atoms

CRef< TBonds >	m_Bonds

list< CRef< CPC_StereoCenter > >	m_Stereo

list< CRef< CPC_Coordinates > >	m_Coords

int	m_Charge

list< CRef< CPC_InfoData > >	m_Props

list< CRef< CPC_StereoGroup > >	m_Stereogroups

CRef< TCount >	m_Count

CRef< TVbalt >	m_Vbalt

list< CRef< CPC_Group > >	m_Groups

Additional Inherited Members
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

Compound Record.

CPC_Compound_Base –

Definition at line 86 of file PC_Compound_.hpp.

The documentation for this class was generated from the following files:

include/objects/pcsubstance/PC_Compound_.hpp
src/objects/pcsubstance/PC_Compound_.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description