Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

MolecularInformation Class Reference
[Object Persistence.]

MolecularInformation class. More...

#include <molecularInformation.h>

Inheritance diagram for MolecularInformation:

Visitor< Composite > List of all members.

Public Types

Enums
enum  Type {
  TYPE__UNKNOWN = -1, TYPE__SYSTEM = 0, TYPE__PROTEIN = 1, TYPE__MOLECULE = 2,
  TYPE__CHAIN = 3, TYPE__FRAGMENT = 4, TYPE__RESIDUE = 5, TYPE__SECONDARY_STRUCTURE = 6,
  TYPE__ATOM = 7, TYPE__BOND = 8
}
 Type. More...

Public Member Functions

Constructors and Destructors
 MolecularInformation () throw ()
 Default Constructor.
virtual ~MolecularInformation () throw ()
 Destructor.
virtual void clear () throw ()
 Explicit default initialization.
Accessors: inspectors and mutators
Type getType () const throw ()
 Return the type of the given composite.
String getName () const throw ()
String getTypeName () const throw ()
virtual void visit (Composite &composite)
 Visit method.

Detailed Description

MolecularInformation class.

This class is used by the class MolecularControl to retrieve names and types of the displayed Composite objects.


Member Enumeration Documentation

enum MolecularInformation::Type
 

Type.

This types are possible.

Enumeration values:
TYPE__UNKNOWN  Unkown type. This value will be set in clear.
TYPE__SYSTEM  System type.
TYPE__PROTEIN  Protein type.
TYPE__MOLECULE  Molecule type.
TYPE__CHAIN  Chain type.
TYPE__FRAGMENT  Fragment type.
TYPE__RESIDUE  Residue type.
TYPE__SECONDARY_STRUCTURE  SecondaryStructure type.
TYPE__ATOM  Atom type.
TYPE__BOND  Bond type.


Constructor & Destructor Documentation

MolecularInformation::MolecularInformation  )  throw ()
 

Default Constructor.

Calls clear.

virtual MolecularInformation::~MolecularInformation  )  throw () [virtual]
 

Destructor.


Member Function Documentation

virtual void MolecularInformation::clear  )  throw () [virtual]
 

Explicit default initialization.

Reset the state of this moleculareInformation to: Calls Information::clear.

  • type is set to TYPE__UNKNOWN

Type MolecularInformation::getType  )  const throw ()
 

Return the type of the given composite.

If the given Composite is of any kind that is defined by the enumeration Type this type will be returned.

Returns:
Type the type of the Composite
See also:
Type

visit

virtual void MolecularInformation::visit Composite composite  )  [virtual]
 

Visit method.

This method tries to determine the name and the type of the Composite object. If the type of composite returned from the method getType is one of the defined type of Type than that name and type is set to the variables name_ and type_name_. If the type is TYPE__UNKOWN than the method getType is called to determine the type.

Parameters:
composite the Composite object whose information should be extracted
See also:
getType

Implements Visitor< Composite >.