PersistentObject Class Reference
[Object Persistence.]

The persistent object. More...

#include <persistentObject.h>

Inheritance diagram for PersistentObject:

List of all members.

Public Member Functions
Constructors and Destructors
	PersistentObject () throw ()
	Default constructor.
virtual	~PersistentObject () throw ()
	Destructor.
Persistent Writing and Reading
PersistenceManager &	operator>> (PersistenceManager &pm) const throw (Exception::GeneralException)
	Stream operator.
virtual void	persistentWrite (PersistenceManager &pm, const char *name="") const throw (Exception::GeneralException)
	Serialize the object.
virtual void	persistentRead (PersistenceManager &pm) throw (Exception::GeneralException)
	Deserialize the object.
virtual void	finalize () throw (Exception::GeneralException)
	Finalize the deserialization.

---

Detailed Description

The persistent object.

Each object that needs persistence, has to be derived from PersistentObject to define an interface to the PersistenceManager .

The class itself has no functionality except for the operator >>.

---

Constructor & Destructor Documentation

PersistentObject::PersistentObject (   )  throw ()

Default constructor. The default constructor has no functionality.

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

Destructor. The destructor has no functionality.

---

Member Function Documentation

virtual void PersistentObject::finalize (   )  throw (Exception::GeneralException) [virtual]

Finalize the deserialization. This method is called for all objects after their pointers have been demangled. It is intended for the adaptation of internal data structures. For example, the bond class has to swap first_ and second_ depending on the order of the atoms. It is usually left unimplemented. Reimplemented in Bond.

PersistenceManager& PersistentObject::operator>> (  PersistenceManager &  pm  )  const throw (Exception::GeneralException)

Stream operator. This operator is used to serialize an instance of PersistentObject. The method first calls pm.startOutput() to write the necessary headers. Then, persistentWrite(pm) is called to serialize the object. Finally, a call to pm.stopOutput() writes all dependend objects and the end marker to the persistent stream. Parameters: pm  the persistence manager Returns: the persistence manager (for chaining multiple output operations)

virtual void PersistentObject::persistentRead (  PersistenceManager &  pm  )  throw (Exception::GeneralException) [virtual]

Deserialize the object. This method reads the contents of an persistent object into an (already existing!) object. It is implemented using Layer 1 commands of PersistenceManager. To each write command used in persistentWrite, there should be exactly the same call to a read command in persistentRead. Only the header and trailer (writeObjectHeader/writeObjectTrailer calls) have to be omitted, as the header is read before this method is called (the object type has to be known in advance to dynamically create the object). Parameters: pm  the PersistenceManager Reimplemented in Composite, NamedProperty, Atom, AtomContainer, Bond, Chain, Fragment, Molecule, NucleicAcid, Nucleotide, PDBAtom, Protein, Residue, SecondaryStructure, System, TVector2< T >, and TVector2< float >.

virtual void PersistentObject::persistentWrite (  PersistenceManager &  pm, const char *  name = "" )  const throw (Exception::GeneralException) [virtual]

Serialize the object. This method serializes the object by calls to Layer 1 methods of PersistenceManager . The first method in the implementation of persistentRead should be a call to pm.writeObjectHeader(*this, name). Likewise the last method in this method should be pm.writeObjectTrailer(name). Parameters: pm  the persistence manager name  the name of the object (0 for writing base classes) Reimplemented in Composite, NamedProperty, Atom, AtomContainer, Bond, Chain, Fragment, Molecule, NucleicAcid, Nucleotide, PDBAtom, Protein, Residue, SecondaryStructure, System, TVector2< T >, and TVector2< float >.