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

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

Search Toolkit Book for CModel_space_Base

#include <Model_space_.hpp>

Inheritance diagram for CModel_space_Base:

[legend]Collaboration diagram for CModel_space_Base:

[legend]List of all members.

---

Detailed Description

The model space defines measurement units and any external reference frame.

Coordinates refer to a right-handed orthogonal system defined on axes tagged x, y and z in the coordinate and feature definitions of a biostruc. Coordinates from PDB-derived structures are reported without change, in angstrom units. The units of temperature and occupancy factors are not defined explicitly in PDB, but are inferred from their value range.

CModel_space_Base --

Definition at line 78 of file Model_space_.hpp.

Public Types
typedef ECoordinate_units	TCoordinate_units
typedef EThermal_factor_units	TThermal_factor_units
typedef EOccupancy_factor_units	TOccupancy_factor_units
typedef EDensity_units	TDensity_units
typedef CReference_frame	TReference_frame
enum	ECoordinate_units { eCoordinate_units_angstroms = 1, eCoordinate_units_nanometers = 2, eCoordinate_units_other = 3, eCoordinate_units_unknown = 255 }
enum	EThermal_factor_units { eThermal_factor_units_b = 1, eThermal_factor_units_u = 2, eThermal_factor_units_other = 3, eThermal_factor_units_unknown = 255 }
enum	EOccupancy_factor_units { eOccupancy_factor_units_fractional = 1, eOccupancy_factor_units_electrons = 2, eOccupancy_factor_units_other = 3, eOccupancy_factor_units_unknown = 255 }
enum	EDensity_units { eDensity_units_electrons_per_unit_volume = 1, eDensity_units_arbitrary_scale = 2, eDensity_units_other = 3, eDensity_units_unknown = 255 }
Public Member Functions
	CModel_space_Base (void)
virtual	~CModel_space_Base (void)
	DECLARE_INTERNAL_TYPE_INFO ()
bool	IsSetCoordinate_units (void) const
	Check if a value has been assigned to Coordinate_units data member.
bool	CanGetCoordinate_units (void) const
	Check if it is safe to call GetCoordinate_units method.
void	ResetCoordinate_units (void)
	Reset Coordinate_units data member.
TCoordinate_units	GetCoordinate_units (void) const
	Get the Coordinate_units member data.
void	SetCoordinate_units (TCoordinate_units value)
	Assign a value to Coordinate_units data member.
TCoordinate_units &	SetCoordinate_units (void)
	Assign a value to Coordinate_units data member.
bool	IsSetThermal_factor_units (void) const
	Check if a value has been assigned to Thermal_factor_units data member.
bool	CanGetThermal_factor_units (void) const
	Check if it is safe to call GetThermal_factor_units method.
void	ResetThermal_factor_units (void)
	Reset Thermal_factor_units data member.
TThermal_factor_units	GetThermal_factor_units (void) const
	Get the Thermal_factor_units member data.
void	SetThermal_factor_units (TThermal_factor_units value)
	Assign a value to Thermal_factor_units data member.
TThermal_factor_units &	SetThermal_factor_units (void)
	Assign a value to Thermal_factor_units data member.
bool	IsSetOccupancy_factor_units (void) const
	Check if a value has been assigned to Occupancy_factor_units data member.
bool	CanGetOccupancy_factor_units (void) const
	Check if it is safe to call GetOccupancy_factor_units method.
void	ResetOccupancy_factor_units (void)
	Reset Occupancy_factor_units data member.
TOccupancy_factor_units	GetOccupancy_factor_units (void) const
	Get the Occupancy_factor_units member data.
void	SetOccupancy_factor_units (TOccupancy_factor_units value)
	Assign a value to Occupancy_factor_units data member.
TOccupancy_factor_units &	SetOccupancy_factor_units (void)
	Assign a value to Occupancy_factor_units data member.
bool	IsSetDensity_units (void) const
	Check if a value has been assigned to Density_units data member.
bool	CanGetDensity_units (void) const
	Check if it is safe to call GetDensity_units method.
void	ResetDensity_units (void)
	Reset Density_units data member.
TDensity_units	GetDensity_units (void) const
	Get the Density_units member data.
void	SetDensity_units (TDensity_units value)
	Assign a value to Density_units data member.
TDensity_units &	SetDensity_units (void)
	Assign a value to Density_units data member.
bool	IsSetReference_frame (void) const
	Check if a value has been assigned to Reference_frame data member.
bool	CanGetReference_frame (void) const
	Check if it is safe to call GetReference_frame method.
void	ResetReference_frame (void)
	Reset Reference_frame data member.
const TReference_frame &	GetReference_frame (void) const
	Get the Reference_frame member data.
void	SetReference_frame (TReference_frame &value)
	Assign a value to Reference_frame data member.
TReference_frame &	SetReference_frame (void)
	Assign a value to Reference_frame data member.
virtual void	Reset (void)
	Reset the whole object.
Private Types
typedef CSerialObject	Tparent
Private Member Functions
	CModel_space_Base (const CModel_space_Base &)
CModel_space_Base &	operator= (const CModel_space_Base &)
Private Attributes
Uint4	m_set_State [1]
TCoordinate_units	m_Coordinate_units
TThermal_factor_units	m_Thermal_factor_units
TOccupancy_factor_units	m_Occupancy_factor_units
TDensity_units	m_Density_units
CRef< TReference_frame >	m_Reference_frame

---

Member Typedef Documentation

typedef ECoordinate_units CModel_space_Base::TCoordinate_units

Definition at line 131 of file Model_space_.hpp.

typedef EDensity_units CModel_space_Base::TDensity_units

Definition at line 134 of file Model_space_.hpp.

typedef EOccupancy_factor_units CModel_space_Base::TOccupancy_factor_units

Definition at line 133 of file Model_space_.hpp.

typedef CSerialObject CModel_space_Base::Tparent [private]

Reimplemented in CModel_space. Definition at line 80 of file Model_space_.hpp.

typedef CReference_frame CModel_space_Base::TReference_frame

Definition at line 135 of file Model_space_.hpp.

typedef EThermal_factor_units CModel_space_Base::TThermal_factor_units

Definition at line 132 of file Model_space_.hpp.

---

Member Enumeration Documentation

enum CModel_space_Base::ECoordinate_units

Enumerator: eCoordinate_units_angstroms  eCoordinate_units_nanometers  eCoordinate_units_other  eCoordinate_units_unknown  Definition at line 90 of file Model_space_.hpp.

enum CModel_space_Base::EDensity_units

Enumerator: eDensity_units_electrons_per_unit_volume  eDensity_units_arbitrary_scale  eDensity_units_other  eDensity_units_unknown  Definition at line 120 of file Model_space_.hpp.

enum CModel_space_Base::EOccupancy_factor_units

Enumerator: eOccupancy_factor_units_fractional  eOccupancy_factor_units_electrons  eOccupancy_factor_units_other  eOccupancy_factor_units_unknown  Definition at line 110 of file Model_space_.hpp.

enum CModel_space_Base::EThermal_factor_units

Enumerator: eThermal_factor_units_b  eThermal_factor_units_u  eThermal_factor_units_other  eThermal_factor_units_unknown  Definition at line 100 of file Model_space_.hpp.

---

Constructor & Destructor Documentation

END_CLASS_INFO CModel_space_Base::CModel_space_Base (  void   )

Definition at line 126 of file Model_space_.cpp. References m_set_State.

CModel_space_Base::~CModel_space_Base (  void   )  [virtual]

Definition at line 133 of file Model_space_.cpp.

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

---

Member Function Documentation

bool CModel_space_Base::CanGetCoordinate_units (  void   )  const [inline]

Check if it is safe to call GetCoordinate_units method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 359 of file Model_space_.hpp. References IsSetCoordinate_units(). Referenced by GetCoordinate_units().

bool CModel_space_Base::CanGetDensity_units (  void   )  const [inline]

Check if it is safe to call GetDensity_units method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 500 of file Model_space_.hpp. References IsSetDensity_units(). Referenced by GetDensity_units().

bool CModel_space_Base::CanGetOccupancy_factor_units (  void   )  const [inline]

Check if it is safe to call GetOccupancy_factor_units method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 453 of file Model_space_.hpp. References IsSetOccupancy_factor_units(). Referenced by GetOccupancy_factor_units().

bool CModel_space_Base::CanGetReference_frame (  void   )  const [inline]

Check if it is safe to call GetReference_frame method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 547 of file Model_space_.hpp. References IsSetReference_frame(). Referenced by GetReference_frame().

bool CModel_space_Base::CanGetThermal_factor_units (  void   )  const [inline]

Check if it is safe to call GetThermal_factor_units method. Returns: true, if the data member is getatable. false, otherwise. Definition at line 406 of file Model_space_.hpp. References IsSetThermal_factor_units(). Referenced by GetThermal_factor_units().

CModel_space_Base::DECLARE_INTERNAL_TYPE_INFO (   )

CModel_space_Base::TCoordinate_units CModel_space_Base::GetCoordinate_units (  void   )  const [inline]

Get the Coordinate_units member data. Returns: Copy of the member data. Definition at line 372 of file Model_space_.hpp. References CanGetCoordinate_units(), m_Coordinate_units, and CSerialObject::ThrowUnassigned().

CModel_space_Base::TDensity_units CModel_space_Base::GetDensity_units (  void   )  const [inline]

Get the Density_units member data. Returns: Copy of the member data. Definition at line 513 of file Model_space_.hpp. References CanGetDensity_units(), m_Density_units, and CSerialObject::ThrowUnassigned().

CModel_space_Base::TOccupancy_factor_units CModel_space_Base::GetOccupancy_factor_units (  void   )  const [inline]

Get the Occupancy_factor_units member data. Returns: Copy of the member data. Definition at line 466 of file Model_space_.hpp. References CanGetOccupancy_factor_units(), m_Occupancy_factor_units, and CSerialObject::ThrowUnassigned().

const CModel_space_Base::TReference_frame & CModel_space_Base::GetReference_frame (  void   )  const [inline]

Get the Reference_frame member data. Returns: Reference to the member data. Definition at line 553 of file Model_space_.hpp. References CanGetReference_frame(), m_Reference_frame, and CSerialObject::ThrowUnassigned().

CModel_space_Base::TThermal_factor_units CModel_space_Base::GetThermal_factor_units (  void   )  const [inline]

Get the Thermal_factor_units member data. Returns: Copy of the member data. Definition at line 419 of file Model_space_.hpp. References CanGetThermal_factor_units(), m_Thermal_factor_units, and CSerialObject::ThrowUnassigned().

bool CModel_space_Base::IsSetCoordinate_units (  void   )  const [inline]

Check if a value has been assigned to Coordinate_units data member. Data member Coordinate_units is mandatory; its type is defined as 'typedef ECoordinate_units TCoordinate_units' Returns: true, if a value has been assigned. false, otherwise. Definition at line 353 of file Model_space_.hpp. References m_set_State. Referenced by CanGetCoordinate_units(), and SetCoordinate_units().

bool CModel_space_Base::IsSetDensity_units (  void   )  const [inline]

Check if a value has been assigned to Density_units data member. Data member Density_units is optional; its type is defined as 'typedef EDensity_units TDensity_units' Returns: true, if a value has been assigned. false, otherwise. Definition at line 494 of file Model_space_.hpp. References m_set_State. Referenced by CanGetDensity_units(), and SetDensity_units().

bool CModel_space_Base::IsSetOccupancy_factor_units (  void   )  const [inline]

Check if a value has been assigned to Occupancy_factor_units data member. Data member Occupancy_factor_units is optional; its type is defined as 'typedef EOccupancy_factor_units TOccupancy_factor_units' Returns: true, if a value has been assigned. false, otherwise. Definition at line 447 of file Model_space_.hpp. References m_set_State. Referenced by CanGetOccupancy_factor_units(), and SetOccupancy_factor_units().

bool CModel_space_Base::IsSetReference_frame (  void   )  const [inline]

Check if a value has been assigned to Reference_frame data member. Data member Reference_frame is optional; its type is defined as 'typedef CReference_frame TReference_frame' Returns: true, if a value has been assigned. false, otherwise. Definition at line 541 of file Model_space_.hpp. References m_Reference_frame, and CRef< C, Locker >::NotEmpty(). Referenced by CanGetReference_frame().

bool CModel_space_Base::IsSetThermal_factor_units (  void   )  const [inline]

Check if a value has been assigned to Thermal_factor_units data member. Data member Thermal_factor_units is optional; its type is defined as 'typedef EThermal_factor_units TThermal_factor_units' Returns: true, if a value has been assigned. false, otherwise. Definition at line 400 of file Model_space_.hpp. References m_set_State. Referenced by CanGetThermal_factor_units(), and SetThermal_factor_units().

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

void CModel_space_Base::Reset (  void   )  [virtual]

Reset the whole object. Definition at line 104 of file Model_space_.cpp. References ResetCoordinate_units(), ResetDensity_units(), ResetOccupancy_factor_units(), ResetReference_frame(), and ResetThermal_factor_units().

void CModel_space_Base::ResetCoordinate_units (  void   )  [inline]

Reset Coordinate_units data member. Definition at line 365 of file Model_space_.hpp. References m_Coordinate_units, and m_set_State. Referenced by Reset().

void CModel_space_Base::ResetDensity_units (  void   )  [inline]

Reset Density_units data member. Definition at line 506 of file Model_space_.hpp. References m_Density_units, and m_set_State. Referenced by Reset().

void CModel_space_Base::ResetOccupancy_factor_units (  void   )  [inline]

Reset Occupancy_factor_units data member. Definition at line 459 of file Model_space_.hpp. References m_Occupancy_factor_units, and m_set_State. Referenced by Reset().

END_ENUM_INFO void CModel_space_Base::ResetReference_frame (  void   )

Reset Reference_frame data member. Definition at line 87 of file Model_space_.cpp. References m_Reference_frame, and CRef< C, Locker >::Reset(). Referenced by Reset().

void CModel_space_Base::ResetThermal_factor_units (  void   )  [inline]

Reset Thermal_factor_units data member. Definition at line 412 of file Model_space_.hpp. References m_set_State, and m_Thermal_factor_units. Referenced by Reset().

CModel_space_Base::TCoordinate_units & CModel_space_Base::SetCoordinate_units (  void   )  [inline]

Assign a value to Coordinate_units data member. Returns: Reference to the data value. Definition at line 388 of file Model_space_.hpp. References IsSetCoordinate_units(), m_Coordinate_units, m_set_State, and CSerialObject::ms_UnassignedByte.

void CModel_space_Base::SetCoordinate_units (  TCoordinate_units  value  )  [inline]

Assign a value to Coordinate_units data member. Parameters: value  Value to assign Definition at line 381 of file Model_space_.hpp. References m_Coordinate_units, and m_set_State.

CModel_space_Base::TDensity_units & CModel_space_Base::SetDensity_units (  void   )  [inline]

Assign a value to Density_units data member. Returns: Reference to the data value. Definition at line 529 of file Model_space_.hpp. References IsSetDensity_units(), m_Density_units, m_set_State, and CSerialObject::ms_UnassignedByte.

void CModel_space_Base::SetDensity_units (  TDensity_units  value  )  [inline]

Assign a value to Density_units data member. Parameters: value  Value to assign Definition at line 522 of file Model_space_.hpp. References m_Density_units, and m_set_State.

CModel_space_Base::TOccupancy_factor_units & CModel_space_Base::SetOccupancy_factor_units (  void   )  [inline]

Assign a value to Occupancy_factor_units data member. Returns: Reference to the data value. Definition at line 482 of file Model_space_.hpp. References IsSetOccupancy_factor_units(), m_Occupancy_factor_units, m_set_State, and CSerialObject::ms_UnassignedByte.

void CModel_space_Base::SetOccupancy_factor_units (  TOccupancy_factor_units  value  )  [inline]

Assign a value to Occupancy_factor_units data member. Parameters: value  Value to assign Definition at line 475 of file Model_space_.hpp. References m_Occupancy_factor_units, and m_set_State.

CModel_space_Base::TReference_frame & CModel_space_Base::SetReference_frame (  void   )

Assign a value to Reference_frame data member. Returns: Reference to the data value. Definition at line 97 of file Model_space_.cpp. References m_Reference_frame, and CRef< C, Locker >::Reset().

void CModel_space_Base::SetReference_frame (  TReference_frame &  value  )

Assign a value to Reference_frame data member. Parameters: value  Reference to value. Definition at line 92 of file Model_space_.cpp. References m_Reference_frame, and CRef< C, Locker >::Reset().

CModel_space_Base::TThermal_factor_units & CModel_space_Base::SetThermal_factor_units (  void   )  [inline]

Assign a value to Thermal_factor_units data member. Returns: Reference to the data value. Definition at line 435 of file Model_space_.hpp. References IsSetThermal_factor_units(), m_set_State, m_Thermal_factor_units, and CSerialObject::ms_UnassignedByte.

void CModel_space_Base::SetThermal_factor_units (  TThermal_factor_units  value  )  [inline]

Assign a value to Thermal_factor_units data member. Parameters: value  Value to assign Definition at line 428 of file Model_space_.hpp. References m_set_State, and m_Thermal_factor_units.

---

Member Data Documentation

TCoordinate_units CModel_space_Base::m_Coordinate_units [private]

Definition at line 336 of file Model_space_.hpp. Referenced by GetCoordinate_units(), ResetCoordinate_units(), and SetCoordinate_units().

TDensity_units CModel_space_Base::m_Density_units [private]

Definition at line 339 of file Model_space_.hpp. Referenced by GetDensity_units(), ResetDensity_units(), and SetDensity_units().

TOccupancy_factor_units CModel_space_Base::m_Occupancy_factor_units [private]

Definition at line 338 of file Model_space_.hpp. Referenced by GetOccupancy_factor_units(), ResetOccupancy_factor_units(), and SetOccupancy_factor_units().

CRef< TReference_frame > CModel_space_Base::m_Reference_frame [private]

Definition at line 340 of file Model_space_.hpp. Referenced by GetReference_frame(), IsSetReference_frame(), ResetReference_frame(), and SetReference_frame().

Uint4 CModel_space_Base::m_set_State[1] [private]

Definition at line 335 of file Model_space_.hpp. Referenced by CModel_space_Base(), IsSetCoordinate_units(), IsSetDensity_units(), IsSetOccupancy_factor_units(), IsSetThermal_factor_units(), ResetCoordinate_units(), ResetDensity_units(), ResetOccupancy_factor_units(), ResetThermal_factor_units(), SetCoordinate_units(), SetDensity_units(), SetOccupancy_factor_units(), and SetThermal_factor_units().

TThermal_factor_units CModel_space_Base::m_Thermal_factor_units [private]

Definition at line 337 of file Model_space_.hpp. Referenced by GetThermal_factor_units(), ResetThermal_factor_units(), and SetThermal_factor_units().

---

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

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

---