mxmTime Class Reference
[modularMX Runtime Platform Core]

Identifies a point in time. More...

#include <mxmTime.h>

Inheritance diagram for mxmTime:

mxmObject List of all members.

Public Member Functions

 mxmTime ()
 Time object will represent the time of its construction.
 mxmTime (const mxmTime &other_time)
bool operator< (const mxmTime &other) const
 "Earlier" operator.
int operator- (const mxmTime &earlier) const
 Computes time difference in milliseconds to specified earlier point in time.
 operator mxm::frame_time () const
 Conversion to mxm::frame_time.
bool timedOut (const mxmTime &earlier, int timeout_ms) const
 Tells whether or not the time specified by timeout_ms has elapsed between earlier and the time called upon.

Static Public Member Functions

static mxmTime now (void)
static void initialize ()
 Initializes the mxmTime subsystem.
static mxm::frame_time getTimeSinceInitialization ()
 Returns the time in microseconds since initialization.

Private Attributes

mxm::frame_time Time
void * StableABIDataExtension

Static Private Attributes

static time_t RefTime
static bool IsInitialized = false
static mxm::frame_time RefTicks = 0

Detailed Description

Identifies a point in time.

Author:
[khe] Kai Hergenroether


Member Function Documentation

mxm::frame_time mxmTime::getTimeSinceInitialization  )  [static]
 

Returns the time in microseconds since initialization.

Returns the time in microseconds since the mxmTime subsystem was initialized by the initialize() method.

void mxmTime::initialize  )  [static]
 

Initializes the mxmTime subsystem.

Initializes the mxmTime subsystem. This method is called once, preferably from mxmApplication, when the application is started. This method fills all static members and is the only method which has write access to them.

int mxmTime::operator- const mxmTime earlier  )  const
 

Computes time difference in milliseconds to specified earlier point in time.

If earlier time is not earlier, the method returns 0.

bool mxmTime::timedOut const mxmTime earlier,
int  timeout_ms
const
 

Tells whether or not the time specified by timeout_ms has elapsed between earlier and the time called upon.

To reasonably respond to the two possible problems of

  • externally induced clock adjustments while executing
  • timer wrap-arounds (unlikely)

we consider the timeout as elapsed if actually the time difference between both specified time stamps exceeds timeout_ms.


The documentation for this class was generated from the following files:
Generated on Fri Jun 29 17:21:05 2007 for MxPEG SDK by  doxygen 1.4.6