CModel_space_points_Base Class Reference
[Code generated by DATATOOL from 'mmdb2.asn' (module 'MMDB-Structural-model')]

Represents ASN.1 type Model-space-points defined in file mmdb2.asn

Search Toolkit Book for CModel_space_points_Base

#include <Model_space_points_.hpp>

Inheritance diagram for CModel_space_points_Base:

[legend]Collaboration diagram for CModel_space_points_Base:

[legend]List of all members.

---

Detailed Description

The atoms whose location is described by each coordinate are identified via a hierarchical pointer to the chemical graph of the biomolecular assembly.

Coordinates may be matched with atoms in the chemical structure by the values of the molecule, residue and atom id's given here, which match exactly the items of the same type defined in Biostruc-graph. Coordinates are given as integer values, with a scale factor to convert to real values for each x, y or z, in the units indicated in model-space. Integer values must be divided by the the scale factor. This use of integer values reduces the ASN.1 stream size. The scale factors for temperature factors and occupancies are given separately, but must be used in the same fashion to produce properly scaled real values.

CModel_space_points_Base --

Definition at line 83 of file Model_space_points_.hpp.

Public Types
typedef int	TScale_factor
typedef list< int >	TX
typedef list< int >	TY
typedef list< int >	TZ
Public Member Functions
	CModel_space_points_Base (void)
virtual	~CModel_space_points_Base (void)
	DECLARE_INTERNAL_TYPE_INFO ()
bool	IsSetScale_factor (void) const
	Check if a value has been assigned to Scale_factor data member.
bool	CanGetScale_factor (void) const
	Check if it is safe to call GetScale_factor method.
void	ResetScale_factor (void)
	Reset Scale_factor data member.
TScale_factor	GetScale_factor (void) const
	Get the Scale_factor member data.
void	SetScale_factor (TScale_factor value)
	Assign a value to Scale_factor data member.
TScale_factor &	SetScale_factor (void)
	Assign a value to Scale_factor data member.
bool	IsSetX (void) const
	Check if a value has been assigned to X data member.
bool	CanGetX (void) const
	Check if it is safe to call GetX method.
void	ResetX (void)
	Reset X data member.
const TX &	GetX (void) const
	Get the X member data.
TX &	SetX (void)
	Assign a value to X data member.
bool	IsSetY (void) const
	Check if a value has been assigned to Y data member.
bool	CanGetY (void) const
	Check if it is safe to call GetY method.
void	ResetY (void)
	Reset Y data member.
const TY &	GetY (void) const
	Get the Y member data.
TY &	SetY (void)
	Assign a value to Y data member.
bool	IsSetZ (void) const
	Check if a value has been assigned to Z data member.
bool	CanGetZ (void) const
	Check if it is safe to call GetZ method.
void	ResetZ (void)
	Reset Z data member.
const TZ &	GetZ (void) const
	Get the Z member data.
TZ &	SetZ (void)
	Assign a value to Z data member.
virtual void	Reset (void)
	Reset the whole object.
Private Types
typedef CSerialObject	Tparent
Private Member Functions
	CModel_space_points_Base (const CModel_space_points_Base &)
CModel_space_points_Base &	operator= (const CModel_space_points_Base &)
Private Attributes
Uint4	m_set_State [1]
TScale_factor	m_Scale_factor
TX	m_X
TY	m_Y
TZ	m_Z

---

Member Typedef Documentation

typedef CSerialObject CModel_space_points_Base::Tparent [private]

Reimplemented in CModel_space_points. Definition at line 85 of file Model_space_points_.hpp.

typedef int CModel_space_points_Base::TScale_factor

Definition at line 96 of file Model_space_points_.hpp.

typedef list< int > CModel_space_points_Base::TX

Definition at line 97 of file Model_space_points_.hpp.

typedef list< int > CModel_space_points_Base::TY

Definition at line 98 of file Model_space_points_.hpp.

typedef list< int > CModel_space_points_Base::TZ

Definition at line 99 of file Model_space_points_.hpp.

---

Constructor & Destructor Documentation

END_CLASS_INFO CModel_space_points_Base::CModel_space_points_Base (  void   )

Definition at line 88 of file Model_space_points_.cpp. References m_set_State.

CModel_space_points_Base::~CModel_space_points_Base (  void   )  [virtual]

Definition at line 95 of file Model_space_points_.cpp.

CModel_space_points_Base::CModel_space_points_Base (  const CModel_space_points_Base &   )  [private]

---

Member Function Documentation

bool CModel_space_points_Base::CanGetScale_factor (  void   )  const [inline]

Check if it is safe to call GetScale_factor method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 267 of file Model_space_points_.hpp. References IsSetScale_factor(). Referenced by GetScale_factor().

bool CModel_space_points_Base::CanGetX (  void   )  const [inline]

Check if it is safe to call GetX method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 314 of file Model_space_points_.hpp.

bool CModel_space_points_Base::CanGetY (  void   )  const [inline]

Check if it is safe to call GetY method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 339 of file Model_space_points_.hpp.

bool CModel_space_points_Base::CanGetZ (  void   )  const [inline]

Check if it is safe to call GetZ method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 364 of file Model_space_points_.hpp.

CModel_space_points_Base::DECLARE_INTERNAL_TYPE_INFO (   )

CModel_space_points_Base::TScale_factor CModel_space_points_Base::GetScale_factor (  void   )  const [inline]

Get the Scale_factor member data. Returns: Copy of the member data. Definition at line 280 of file Model_space_points_.hpp. References CanGetScale_factor(), m_Scale_factor, and CSerialObject::ThrowUnassigned().

const CModel_space_points_Base::TX & CModel_space_points_Base::GetX (  void   )  const [inline]

Get the X member data. Returns: Reference to the member data. Definition at line 320 of file Model_space_points_.hpp. References m_X.

const CModel_space_points_Base::TY & CModel_space_points_Base::GetY (  void   )  const [inline]

Get the Y member data. Returns: Reference to the member data. Definition at line 345 of file Model_space_points_.hpp. References m_Y.

const CModel_space_points_Base::TZ & CModel_space_points_Base::GetZ (  void   )  const [inline]

Get the Z member data. Returns: Reference to the member data. Definition at line 370 of file Model_space_points_.hpp. References m_Z.

bool CModel_space_points_Base::IsSetScale_factor (  void   )  const [inline]

Check if a value has been assigned to Scale_factor data member. Data member Scale_factor is mandatory; its type is defined as 'typedef int TScale_factor' Returns: true, if a value has been assigned. false, otherwise. Definition at line 261 of file Model_space_points_.hpp. References m_set_State. Referenced by CanGetScale_factor(), and SetScale_factor().

bool CModel_space_points_Base::IsSetX (  void   )  const [inline]

Check if a value has been assigned to X data member. Data member X is mandatory; its type is defined as 'typedef list< int > TX' Returns: true, if a value has been assigned. false, otherwise. Definition at line 308 of file Model_space_points_.hpp. References m_set_State.

bool CModel_space_points_Base::IsSetY (  void   )  const [inline]

Check if a value has been assigned to Y data member. Data member Y is mandatory; its type is defined as 'typedef list< int > TY' Returns: true, if a value has been assigned. false, otherwise. Definition at line 333 of file Model_space_points_.hpp. References m_set_State.

bool CModel_space_points_Base::IsSetZ (  void   )  const [inline]

Check if a value has been assigned to Z data member. Data member Z is mandatory; its type is defined as 'typedef list< int > TZ' Returns: true, if a value has been assigned. false, otherwise. Definition at line 358 of file Model_space_points_.hpp. References m_set_State.

CModel_space_points_Base& CModel_space_points_Base::operator= (  const CModel_space_points_Base &   )  [private]

void CModel_space_points_Base::Reset (  void   )  [virtual]

Reset the whole object. Definition at line 68 of file Model_space_points_.cpp. References ResetScale_factor(), ResetX(), ResetY(), and ResetZ().

void CModel_space_points_Base::ResetScale_factor (  void   )  [inline]

Reset Scale_factor data member. Definition at line 273 of file Model_space_points_.hpp. References m_Scale_factor, and m_set_State. Referenced by Reset().

void CModel_space_points_Base::ResetX (  void   )

Reset X data member. Definition at line 50 of file Model_space_points_.cpp. References m_set_State, and m_X. Referenced by Reset().

void CModel_space_points_Base::ResetY (  void   )

Reset Y data member. Definition at line 56 of file Model_space_points_.cpp. References m_set_State, and m_Y. Referenced by Reset().

void CModel_space_points_Base::ResetZ (  void   )

Reset Z data member. Definition at line 62 of file Model_space_points_.cpp. References m_set_State, and m_Z. Referenced by Reset().

CModel_space_points_Base::TScale_factor & CModel_space_points_Base::SetScale_factor (  void   )  [inline]

Assign a value to Scale_factor data member. Returns: Reference to the data value. Definition at line 296 of file Model_space_points_.hpp. References IsSetScale_factor(), m_Scale_factor, m_set_State, and CSerialObject::ms_UnassignedByte.

void CModel_space_points_Base::SetScale_factor (  TScale_factor  value  )  [inline]

Assign a value to Scale_factor data member. Parameters: value  Value to assign Definition at line 289 of file Model_space_points_.hpp. References m_Scale_factor, and m_set_State.

CModel_space_points_Base::TX & CModel_space_points_Base::SetX (  void   )  [inline]

Assign a value to X data member. Returns: Reference to the data value. Definition at line 326 of file Model_space_points_.hpp. References m_set_State, and m_X.

CModel_space_points_Base::TY & CModel_space_points_Base::SetY (  void   )  [inline]

Assign a value to Y data member. Returns: Reference to the data value. Definition at line 351 of file Model_space_points_.hpp. References m_set_State, and m_Y.

CModel_space_points_Base::TZ & CModel_space_points_Base::SetZ (  void   )  [inline]

Assign a value to Z data member. Returns: Reference to the data value. Definition at line 376 of file Model_space_points_.hpp. References m_set_State, and m_Z.

---

Member Data Documentation

TScale_factor CModel_space_points_Base::m_Scale_factor [private]

Definition at line 245 of file Model_space_points_.hpp. Referenced by GetScale_factor(), ResetScale_factor(), and SetScale_factor().

Uint4 CModel_space_points_Base::m_set_State[1] [private]

Definition at line 244 of file Model_space_points_.hpp. Referenced by CModel_space_points_Base(), IsSetScale_factor(), IsSetX(), IsSetY(), IsSetZ(), ResetScale_factor(), ResetX(), ResetY(), ResetZ(), SetScale_factor(), SetX(), SetY(), and SetZ().

TX CModel_space_points_Base::m_X [private]

Definition at line 246 of file Model_space_points_.hpp. Referenced by GetX(), ResetX(), and SetX().

TY CModel_space_points_Base::m_Y [private]

Definition at line 247 of file Model_space_points_.hpp. Referenced by GetY(), ResetY(), and SetY().

TZ CModel_space_points_Base::m_Z [private]

Definition at line 248 of file Model_space_points_.hpp. Referenced by GetZ(), ResetZ(), and SetZ().

---

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

• include/objects/mmdb2/Model_space_points_.hpp
• src/objects/mmdb2/Model_space_points_.cpp

---