Search Toolkit Book for CChem_graph_interaction_Base

#include <objects/mmdb3/Chem_graph_interaction_.hpp>

Inheritance diagram for CChem_graph_interaction_Base:

Collaboration diagram for CChem_graph_interaction_Base:

Public Types
enum	EType { eType_protein_protein = 1 , eType_protein_dna = 2 , eType_protein_rna = 3 , eType_protein_chemical = 4 , eType_dna_dna = 5 , eType_dna_rna = 6 , eType_dna_chemical = 7 , eType_rna_rna = 8 , eType_rna_chemical = 9 , eType_other = 255 }

enum class	E_memberIndex { e__allMandatory = 0 , e_type , e_distance_threshold , e_interactors , e_residue_contacts , e_atom_contacts , e_atom_distance }

typedef int	TType

typedef CRealValue	TDistance_threshold

typedef list< CRef< CBiostruc_molecule_pntr > >	TInteractors

typedef list< CRef< CChem_graph_pntrs > >	TResidue_contacts

typedef list< CRef< CChem_graph_pntrs > >	TAtom_contacts

typedef list< CRef< CRealValue > >	TAtom_distance

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< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
	CChem_graph_interaction_Base (void)

virtual	~CChem_graph_interaction_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

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...

bool	IsSetDistance_threshold (void) const
	Check if a value has been assigned to Distance_threshold data member. More...

bool	CanGetDistance_threshold (void) const
	Check if it is safe to call GetDistance_threshold method. More...

void	ResetDistance_threshold (void)
	Reset Distance_threshold data member. More...

const TDistance_threshold &	GetDistance_threshold (void) const
	Get the Distance_threshold member data. More...

void	SetDistance_threshold (TDistance_threshold &value)
	Assign a value to Distance_threshold data member. More...

TDistance_threshold &	SetDistance_threshold (void)
	Assign a value to Distance_threshold data member. More...

bool	IsSetInteractors (void) const
	Check if a value has been assigned to Interactors data member. More...

bool	CanGetInteractors (void) const
	Check if it is safe to call GetInteractors method. More...

void	ResetInteractors (void)
	Reset Interactors data member. More...

const TInteractors &	GetInteractors (void) const
	Get the Interactors member data. More...

TInteractors &	SetInteractors (void)
	Assign a value to Interactors data member. More...

bool	IsSetResidue_contacts (void) const
	Check if a value has been assigned to Residue_contacts data member. More...

bool	CanGetResidue_contacts (void) const
	Check if it is safe to call GetResidue_contacts method. More...

void	ResetResidue_contacts (void)
	Reset Residue_contacts data member. More...

const TResidue_contacts &	GetResidue_contacts (void) const
	Get the Residue_contacts member data. More...

TResidue_contacts &	SetResidue_contacts (void)
	Assign a value to Residue_contacts data member. More...

bool	IsSetAtom_contacts (void) const
	Check if a value has been assigned to Atom_contacts data member. More...

bool	CanGetAtom_contacts (void) const
	Check if it is safe to call GetAtom_contacts method. More...

void	ResetAtom_contacts (void)
	Reset Atom_contacts data member. More...

const TAtom_contacts &	GetAtom_contacts (void) const
	Get the Atom_contacts member data. More...

TAtom_contacts &	SetAtom_contacts (void)
	Assign a value to Atom_contacts data member. More...

bool	IsSetAtom_distance (void) const
	Check if a value has been assigned to Atom_distance data member. More...

bool	CanGetAtom_distance (void) const
	Check if it is safe to call GetAtom_distance method. More...

void	ResetAtom_distance (void)
	Reset Atom_distance data member. More...

const TAtom_distance &	GetAtom_distance (void) const
	Get the Atom_distance member data. More...

TAtom_distance &	SetAtom_distance (void)
	Assign a value to Atom_distance 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()	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
	CChem_graph_interaction_Base (const CChem_graph_interaction_Base &)

CChem_graph_interaction_Base &	operator= (const CChem_graph_interaction_Base &)

Private Attributes
Uint4	m_set_State [1]

int	m_Type

CRef< TDistance_threshold >	m_Distance_threshold

list< CRef< CBiostruc_molecule_pntr > >	m_Interactors

list< CRef< CChem_graph_pntrs > >	m_Residue_contacts

list< CRef< CChem_graph_pntrs > >	m_Atom_contacts

list< CRef< CRealValue > >	m_Atom_distance

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

CChem_graph_interaction_Base –.

Definition at line 78 of file Chem_graph_interaction_.hpp.

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

include/objects/mmdb3/Chem_graph_interaction_.hpp
src/objects/mmdb3/Chem_graph_interaction_.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description