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

Object Class Reference
[Miscellaneous]

Generic object class. More...

#include <object.h>

Inheritance diagram for Object:

AutoDeletable PersistentObject VIEW::Renderer VIEW::RepresentationManager Composite NamedProperty TVector2< T > TVector2< float > VIEW::GLRenderer VIEW::POVRenderer VIEW::VRMLRenderer Atom AtomContainer Bond PDBAtom Chain Fragment Molecule SecondaryStructure System Nucleotide Residue NucleicAcid Protein List of all members.

Handle Management

Handle getHandle () const throw ()
 Return the global handle of this object.
Handle getNextHandle () throw ()
 Return the next available handle without changing the global handle counter.
Handle getNewHandle () throw ()
 Return the next available handle and increase the global handle counter.

Public Member Functions

Construction and Destruction
 Object () throw ()
 Default constructor.
 Object (const Object &object) throw ()
 Copy constructor.
virtual ~Object () throw ()
 Destructor.
virtual void clear () throw ()
 Clear function of the OCI, doing nothing here.
Assignment
const Objectoperator= (const Object &) throw ()
 Assignment operator.
Comparison operators
bool operator== (const Object &object) const throw ()
 Equality operator.
bool operator!= (const Object &object) const throw ()
 Inequality operator.
bool operator< (const Object &object) const throw ()
 Less than operator.
bool operator<= (const Object &object) const throw ()
 Less than or equal operator.
bool operator>= (const Object &object) const throw ()
 Greater than or equal operator.
bool operator> (const Object &object) const throw ()
 Greater than operator.
int compare (const Object &object) const throw ()
 Compare the handle of this object with the handle of another.
Debugging and Diagnostics
virtual bool isValid () const throw ()
virtual void dump (::std::ostream &s=std::cout, Size depth=0) const throw ()

Detailed Description

Generic object class.

This class provides unique handles for every object that is an instance of a derived class of object. Together with the BALL object manager this class also provides a double linked list of all objects.


Member Function Documentation

int Object::compare const Object object  )  const throw ()
 

Compare the handle of this object with the handle of another.

Parameters:
object an Object
Returns:
0, if both objects are equal, -1 if object's handle is greater and 1 if this's handle is greater.

Handle Object::getHandle  )  const throw ()
 

Return the global handle of this object.

Returns:
the handle of this object

Handle Object::getNewHandle  )  throw () [static]
 

Return the next available handle and increase the global handle counter.

Returns:
the next available handle

Handle Object::getNextHandle  )  throw () [static]
 

Return the next available handle without changing the global handle counter.

Returns:
the next available handle

bool Object::operator!= const Object object  )  const throw ()
 

Inequality operator.

This operator checks Object features only, i. e. the handle.

Parameters:
object an Object
Returns:
true, if object and this are not the same object, false ow.

bool Object::operator< const Object object  )  const throw ()
 

Less than operator.

This method checks whether the handle of this object is less than the handle of object

Parameters:
object an Object
Returns:
true, if the handle of this is less than the handle of object

bool Object::operator<= const Object object  )  const throw ()
 

Less than or equal operator.

This method checks whether the handle of this object is less than or equal to the handle of object

Parameters:
object an Object
Returns:
true, if the handle of this is less than or equal to the handle of object

const Object& Object::operator= const Object  )  throw ()
 

Assignment operator.

This method does not assign anything! Implemented just for the OCI.

Parameters:
object an object
Returns:
this object

bool Object::operator== const Object object  )  const throw ()
 

Equality operator.

This operator checks Object features only, i. e. the handle.

Parameters:
object an Object
Returns:
true, if object and this are the same, false ow.

bool Object::operator> const Object object  )  const throw ()
 

Greater than operator.

This method checks whether the handle of this object is greater than the handle of object

Parameters:
object an Object
Returns:
true, if the handle of this is greater than the handle of object

bool Object::operator>= const Object object  )  const throw ()
 

Greater than or equal operator.

This method checks whether the handle of this object is greater than or equal to the handle of object

Parameters:
object an Object
Returns:
true, if the handle of this is greater than or equal to the handle of object