Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

TimeStamp Class Reference
[Concept]

#include <OpenMS/CONCEPT/TimeStamp.h>

List of all members.


Detailed Description

Time stamp class.

This class implements a so-called time stamp. It is used to store modification or creation times of objects.

Public Member Functions

Constructors and Destructors
 TimeStamp () throw ()
virtual ~TimeStamp () throw ()
Predicates
bool isNewerThan (const PreciseTime &time) const throw ()
bool isOlderThan (const PreciseTime &time) const throw ()
bool isNewerThan (const TimeStamp &stamp) const throw ()
bool isOlderThan (const TimeStamp &stamp) const throw ()
bool operator== (const TimeStamp &stamp) const throw ()
bool operator< (const TimeStamp &stamp) const throw ()
bool operator> (const TimeStamp &stamp) const throw ()
Accessors
virtual void stamp (const PreciseTime &time=PreciseTime::ZERO) throw ()
const PreciseTimegetTime () const throw ()
Assignment
const PreciseTimeoperator= (const PreciseTime &time) throw ()
virtual void clear () throw ()

Protected Attributes

PreciseTime time_


Constructor & Destructor Documentation

TimeStamp (  )  throw ()

Default constructor

~TimeStamp (  )  throw () [inline, virtual]

Destructor


Member Function Documentation

bool isNewerThan ( const PreciseTime time  )  const throw () [inline]

Check the time stamp.

bool isOlderThan ( const PreciseTime time  )  const throw () [inline]

Check the time stamp.

bool isNewerThan ( const TimeStamp stamp  )  const throw () [inline]

Check the time stamp.

bool isOlderThan ( const TimeStamp stamp  )  const throw () [inline]

Check the time stamp.

bool operator== ( const TimeStamp stamp  )  const throw () [inline]

Equality operator

bool operator< ( const TimeStamp stamp  )  const throw () [inline]

Lesser than operator.

bool operator> ( const TimeStamp stamp  )  const throw () [inline]

Greater than operator.

void stamp ( const PreciseTime time = PreciseTime::ZERO  )  throw () [inline, virtual]

Update the time stamp. Store the value of time in the internal time stamp. If time is 0, use the current time (as given by PreciseTime::now ).

Parameters:
time the new time stamp (default = PreciseTime::now )

const PreciseTime & getTime (  )  const throw () [inline]

Return the time of last modification

Returns:
the time stamp

const PreciseTime& operator= ( const PreciseTime time  )  throw ()

Assignment operator

void clear (  )  throw () [inline, virtual]

Clear method


Member Data Documentation

PreciseTime time_ [protected]

The time stamp.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:43 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1