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

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

Search Toolkit Book for CModel_coordinate_set_Base

#include <Model_coordinate_set_.hpp>

Inheritance diagram for CModel_coordinate_set_Base:

Inheritance graph
[legend]
Collaboration diagram for CModel_coordinate_set_Base:

Collaboration graph
[legend]
List of all members.

Detailed Description

Atomic coordinates may be assigned literally or by reference to another biostruc.

The reference coordinate type is used to represent homology- derived model structures. PDB-derived structures have literal coordinates. Referenced coordinates identify another biostruc, any transformation to be applied to coordinates from that biostruc, and a mapping of the chemical graph of the present biostruc onto that of the referenced biostruc. They give an "alignment" of atoms in the current biostruc with those in another, from which the coordinates of matched atoms may be retrieved. For non- atomic models "alignment" may also be represented by molecule and residue equivalence lists. Referenced coordinates are a data item inteded for representation of homology models, with an explicit pointer to their source information. They do not occur in PDB-derived models.

CModel_coordinate_set_Base --

Definition at line 91 of file Model_coordinate_set_.hpp.

Public Types

typedef CModel_coordinate_set_id TId
typedef list< CRef< CModel_descr > > TDescr
typedef C_Coordinates TCoordinates

Public Member Functions

 CModel_coordinate_set_Base (void)
virtual ~CModel_coordinate_set_Base (void)
 DECLARE_INTERNAL_TYPE_INFO ()
bool IsSetId (void) const
 Check if a value has been assigned to Id data member.
bool CanGetId (void) const
 Check if it is safe to call GetId method.
void ResetId (void)
 Reset Id data member.
const TId & GetId (void) const
 Get the Id member data.
void SetId (const TId &value)
 Assign a value to Id data member.
TId & SetId (void)
 Assign a value to Id data member.
bool IsSetDescr (void) const
 Check if a value has been assigned to Descr data member.
bool CanGetDescr (void) const
 Check if it is safe to call GetDescr method.
void ResetDescr (void)
 Reset Descr data member.
const TDescr & GetDescr (void) const
 Get the Descr member data.
TDescr & SetDescr (void)
 Assign a value to Descr data member.
bool IsSetCoordinates (void) const
 Check if a value has been assigned to Coordinates data member.
bool CanGetCoordinates (void) const
 Check if it is safe to call GetCoordinates method.
void ResetCoordinates (void)
 Reset Coordinates data member.
const TCoordinates & GetCoordinates (void) const
 Get the Coordinates member data.
void SetCoordinates (TCoordinates &value)
 Assign a value to Coordinates data member.
TCoordinates & SetCoordinates (void)
 Assign a value to Coordinates data member.
virtual void Reset (void)
 Reset the whole object.

Private Types

typedef CSerialObject Tparent

Private Member Functions

 CModel_coordinate_set_Base (const CModel_coordinate_set_Base &)
CModel_coordinate_set_Base & operator= (const CModel_coordinate_set_Base &)

Private Attributes

Uint4 m_set_State [1]
TId m_Id
TDescr m_Descr
CRef< TCoordinates > m_Coordinates

Classes

class  C_Coordinates
 C_Coordinates --. More...

Member Typedef Documentation

typedef C_Coordinates CModel_coordinate_set_Base::TCoordinates
 

Definition at line 252 of file Model_coordinate_set_.hpp.

typedef list< CRef< CModel_descr > > CModel_coordinate_set_Base::TDescr
 

Definition at line 251 of file Model_coordinate_set_.hpp.

typedef CModel_coordinate_set_id CModel_coordinate_set_Base::TId
 

Definition at line 250 of file Model_coordinate_set_.hpp.

typedef CSerialObject CModel_coordinate_set_Base::Tparent [private]
 

Reimplemented in CModel_coordinate_set.

Definition at line 93 of file Model_coordinate_set_.hpp.

Constructor & Destructor Documentation

END_CLASS_INFO CModel_coordinate_set_Base::CModel_coordinate_set_Base (  void   ) 
 

Definition at line 203 of file Model_coordinate_set_.cpp.

References CObject::IsAllocatedInPool(), m_set_State, and ResetCoordinates().

CModel_coordinate_set_Base::~CModel_coordinate_set_Base (  void   )  [virtual]
 

Definition at line 213 of file Model_coordinate_set_.cpp.

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

Member Function Documentation

bool CModel_coordinate_set_Base::CanGetCoordinates (  void   )  const [inline]
 

Check if it is safe to call GetCoordinates method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 502 of file Model_coordinate_set_.hpp.

bool CModel_coordinate_set_Base::CanGetDescr (  void   )  const [inline]
 

Check if it is safe to call GetDescr method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 477 of file Model_coordinate_set_.hpp.

bool CModel_coordinate_set_Base::CanGetId (  void   )  const [inline]
 

Check if it is safe to call GetId method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 435 of file Model_coordinate_set_.hpp.

References IsSetId().

Referenced by GetId().

CModel_coordinate_set_Base::DECLARE_INTERNAL_TYPE_INFO (   ) 
 

const CModel_coordinate_set_Base::TCoordinates & CModel_coordinate_set_Base::GetCoordinates (  void   )  const [inline]
 

Get the Coordinates member data.

Returns:
Reference to the member data.

Definition at line 508 of file Model_coordinate_set_.hpp.

References m_Coordinates, and ResetCoordinates().

const CModel_coordinate_set_Base::TDescr & CModel_coordinate_set_Base::GetDescr (  void   )  const [inline]
 

Get the Descr member data.

Returns:
Reference to the member data.

Definition at line 483 of file Model_coordinate_set_.hpp.

References m_Descr.

const CModel_coordinate_set_Base::TId & CModel_coordinate_set_Base::GetId (  void   )  const [inline]
 

Get the Id member data.

Returns:
Reference to the member data.

Definition at line 448 of file Model_coordinate_set_.hpp.

References CanGetId(), m_Id, and CSerialObject::ThrowUnassigned().

bool CModel_coordinate_set_Base::IsSetCoordinates (  void   )  const [inline]
 

Check if a value has been assigned to Coordinates data member.

Data member Coordinates is mandatory; its type is defined as 'typedef C_Coordinates TCoordinates'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 496 of file Model_coordinate_set_.hpp.

References m_Coordinates, and CRef< C, Locker >::NotEmpty().

bool CModel_coordinate_set_Base::IsSetDescr (  void   )  const [inline]
 

Check if a value has been assigned to Descr data member.

Data member Descr is optional; its type is defined as 'typedef list< CRef< CModel_descr > > TDescr'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 471 of file Model_coordinate_set_.hpp.

References m_set_State.

bool CModel_coordinate_set_Base::IsSetId (  void   )  const [inline]
 

Check if a value has been assigned to Id data member.

Data member Id is optional; its type is defined as 'typedef CModel_coordinate_set_id TId'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 429 of file Model_coordinate_set_.hpp.

References m_set_State.

Referenced by CanGetId().

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

void CModel_coordinate_set_Base::Reset (  void   )  [virtual]
 

Reset the whole object.

Definition at line 185 of file Model_coordinate_set_.cpp.

References ResetCoordinates(), ResetDescr(), and ResetId().

void CModel_coordinate_set_Base::ResetCoordinates (  void   ) 
 

Reset Coordinates data member.

Definition at line 171 of file Model_coordinate_set_.cpp.

References m_Coordinates, and CRef< C, Locker >::Reset().

Referenced by CModel_coordinate_set_Base(), GetCoordinates(), Reset(), and SetCoordinates().

void CModel_coordinate_set_Base::ResetDescr (  void   ) 
 

Reset Descr data member.

Definition at line 165 of file Model_coordinate_set_.cpp.

References m_Descr, and m_set_State.

Referenced by Reset().

void CModel_coordinate_set_Base::ResetId (  void   )  [inline]
 

Reset Id data member.

Definition at line 441 of file Model_coordinate_set_.hpp.

References m_Id, and m_set_State.

Referenced by Reset().

CModel_coordinate_set_Base::TCoordinates & CModel_coordinate_set_Base::SetCoordinates (  void   )  [inline]
 

Assign a value to Coordinates data member.

Returns:
Reference to the data value.

Definition at line 517 of file Model_coordinate_set_.hpp.

References m_Coordinates, and ResetCoordinates().

void CModel_coordinate_set_Base::SetCoordinates (  TCoordinates &  value  ) 
 

Assign a value to Coordinates data member.

Parameters:
value Reference to value.

Definition at line 180 of file Model_coordinate_set_.cpp.

References m_Coordinates, and CRef< C, Locker >::Reset().

CModel_coordinate_set_Base::TDescr & CModel_coordinate_set_Base::SetDescr (  void   )  [inline]
 

Assign a value to Descr data member.

Returns:
Reference to the data value.

Definition at line 489 of file Model_coordinate_set_.hpp.

References m_Descr, and m_set_State.

CModel_coordinate_set_Base::TId & CModel_coordinate_set_Base::SetId (  void   )  [inline]
 

Assign a value to Id data member.

Returns:
Reference to the data value.

Definition at line 464 of file Model_coordinate_set_.hpp.

References m_Id, and m_set_State.

void CModel_coordinate_set_Base::SetId (  const TId &  value  )  [inline]
 

Assign a value to Id data member.

Parameters:
value Value to assign

Definition at line 457 of file Model_coordinate_set_.hpp.

References m_Id, and m_set_State.

Member Data Documentation

CRef< TCoordinates > CModel_coordinate_set_Base::m_Coordinates [private]
 

Definition at line 375 of file Model_coordinate_set_.hpp.

Referenced by GetCoordinates(), IsSetCoordinates(), ResetCoordinates(), and SetCoordinates().

TDescr CModel_coordinate_set_Base::m_Descr [private]
 

Definition at line 374 of file Model_coordinate_set_.hpp.

Referenced by GetDescr(), ResetDescr(), and SetDescr().

TId CModel_coordinate_set_Base::m_Id [private]
 

Definition at line 373 of file Model_coordinate_set_.hpp.

Referenced by GetId(), ResetId(), and SetId().

Uint4 CModel_coordinate_set_Base::m_set_State[1] [private]
 

Definition at line 372 of file Model_coordinate_set_.hpp.

Referenced by CModel_coordinate_set_Base(), IsSetDescr(), IsSetId(), ResetDescr(), ResetId(), SetDescr(), and SetId().

The documentation for this class was generated from the following files:
Generated on Mon Dec 7 12:56:07 2009 for NCBI C++ ToolKit by  doxygen 1.4.6
Modified on Mon Dec 07 16:23:28 2009 by modify_doxy.py rev. 173732