Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Member Functions | Protected Attributes

PersistentObject Class Reference
[Database IO]

Base class for all persistent objects. More...

#include <OpenMS/FORMAT/DB/PersistentObject.h>

Inheritance diagram for PersistentObject:
MSSpectrum<> MSChromatogram< PeakT > MSExperiment< PeakT, ChromatogramPeakT > MSSpectrum< PeakT > BinnedSpectrum

List of all members.

Public Member Functions

 PersistentObject ()
 Default constructor.
virtual ~PersistentObject ()
 Destructor.
PersistentObject & operator= (const PersistentObject &rhs)
 Assignment operator.
const UID & getPersistenceId () const
 Returns the persistence id.
void setPersistenceId (const UID &persistence_id)
 Sets the persistence id.
void clearId (bool deep=true)
 Clears the persistence id.

Protected Member Functions

virtual void clearChildIds_ ()=0
 Clears the persistence id of all sub-objects.

Protected Attributes

UID persistence_id_
 A persistence id used to refer the data back to the source.

Detailed Description

Base class for all persistent objects.

Interface for all classes that can be stored persistently in the OpenMS DB.

Constructor & Destructor Documentation

PersistentObject (  ) 

Default constructor.

virtual ~PersistentObject (  )  [virtual]

Destructor.

Member Function Documentation

virtual void clearChildIds_ (  )  [protected, pure virtual]

Clears the persistence id of all sub-objects.

Implemented in BinnedSpectrum, MSChromatogram< PeakT >, MSExperiment< PeakT, ChromatogramPeakT >, MSSpectrum< PeakT >, MSChromatogram< ChromatogramPeakType >, MSExperiment< Peak1D >, MSExperiment< SimPointType >, MSSpectrum< PeakType >, MSSpectrum< Peak1D >, MSSpectrum<>, MSSpectrum< SimPointType >, and MSSpectrum< RichPeak1D >.

void clearId ( bool  deep = true  ) 

Clears the persistence id.

Sets the id to 0.

Parameters:
deep determines which ids are cleared. false means that only the id of the current object is reset. true means that the ids of all sub-objects are reset as well (default).

Referenced by MSSpectrum< RichPeak1D >::clear(), MSExperiment< SimPointType >::clear(), and MSChromatogram< ChromatogramPeakType >::clear().

const UID& getPersistenceId (  )  const

Returns the persistence id.

This id is only used in the DBAdapter the id is used to connect the object to the data stored in the DB.

PersistentObject& operator= ( const PersistentObject &  rhs  ) 

Assignment operator.

void setPersistenceId ( const UID &  persistence_id  ) 

Sets the persistence id.

This id is only used in the DBAdapter the id is used to connect the object to the data stored in the DB.
Do not set the persistence id unless you know what you are doing!

Member Data Documentation

UID persistence_id_ [protected]

A persistence id used to refer the data back to the source.

OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:53 using doxygen 1.7.1