OTimeIndex Class Reference

Deals with the elapsed simulation time. More...

#include <OsirisSDK/OTimeIndex.h>

Public Member Functions
	OTimeIndex ()
	Class constructor.
	OTimeIndex (int sec, int usec)
	Class constructor. More...
	OTimeIndex (long long timeIndex_us)
	Class constructor. More...
virtual	~OTimeIndex ()
	Class destructor.
OTimeIndex	operator- (const OTimeIndex &in) const
	Subtraction operator.
OTimeIndex	operator- (int in) const
	Subtraction operator. More...
OTimeIndex &	operator-= (const OTimeIndex &in)
	Subtraction operator.
OTimeIndex &	operator-= (int in)
	Subtraction operator. More...
OTimeIndex	operator+ (const OTimeIndex &in) const
	Addition operator.
OTimeIndex	operator+ (int in) const
	Addition operator. More...
OTimeIndex &	operator+= (const OTimeIndex &in)
	Addition operator.
OTimeIndex &	operator+= (int in)
	Addition operator. More...
OTimeIndex &	operator= (int in)
	Assignment operator. More...
bool	operator< (const OTimeIndex &in) const
	Less than comparison operator.
bool	operator< (int in) const
	Less than comparison operator. More...
bool	operator> (const OTimeIndex &in) const
	Greater than comparison operator.
bool	operator> (int in) const
	Greater than comparison operator. More...
bool	operator<= (const OTimeIndex &in) const
	Less than or equal comparison operator.
bool	operator<= (int in) const
	Less than or equal comparison operator. More...
bool	operator>= (const OTimeIndex &in) const
	Greater than or equal comparison operator.
bool	operator>= (int in) const
	Greater than or equal comparison operator. More...
bool	operator== (const OTimeIndex &in) const
	Equals comparison operator.
bool	operator== (int in) const
	Equal comparison operator. More...
bool	operator!= (const OTimeIndex &in) const
	Not equal comparison operator.
bool	operator!= (int in) const
	Not equal comparison operator. More...
void	setValue (int sec, int uSec)
	Set time index component values. More...
int	sec () const
	Returns the time index as an integer in seconds.
int	uSec () const
	Returns the additional microseconds part of the index.
int	toInt () const
	Converts the time index to an integer in microseconds.

Static Public Member Functions
static void	init ()
	Class initialization method.
static OTimeIndex	current ()
	Returns current time index.

Detailed Description

Deals with the elapsed simulation time.

Constructor & Destructor Documentation

OTimeIndex::OTimeIndex	(	int	sec,
		int	usec
	)

Class constructor.

Parameters

sec	Time in seconds.
usec	Additional time in microseconds.

OTimeIndex::OTimeIndex

(

long long

timeIndex_us

)

Class constructor.

Parameters

timeIndex_ms

Time index in microseconds.

Member Function Documentation

bool OTimeIndex::operator!= ( int  in ) const

inline

Not equal comparison operator.

in Time index in microseconds.

OTimeIndex OTimeIndex::operator+ ( int  in ) const

inline

Addition operator.

Parameters

in	Time index in microseconds.

OTimeIndex & OTimeIndex::operator+= ( int  in )

inline

Addition operator.

Parameters

in	Time index in microseconds.

OTimeIndex OTimeIndex::operator- ( int  in ) const

inline

Subtraction operator.

Parameters

in	Time index in microseconds.

OTimeIndex & OTimeIndex::operator-= ( int  in )

inline

Subtraction operator.

Parameters

in	Time index in microseconds.

bool OTimeIndex::operator< ( int  in ) const

inline

Less than comparison operator.

Parameters

in	Time index in microseconds.

bool OTimeIndex::operator<= ( int  in ) const

inline

Less than or equal comparison operator.

Parameters

in	Time index in microseconds.

OTimeIndex & OTimeIndex::operator= ( int  in )

inline

Assignment operator.

Parameters

in	Time index in microseconds.

bool OTimeIndex::operator== ( int  in ) const

inline

Equal comparison operator.

in Time index in microseconds.

bool OTimeIndex::operator> ( int  in ) const

inline

Greater than comparison operator.

Parameters

in	Time index in microseconds.

bool OTimeIndex::operator>= ( int  in ) const

inline

Greater than or equal comparison operator.

Parameters

in	Time index in microseconds.

void OTimeIndex::setValue	(	int	sec,
		int	uSec
	)

Set time index component values.

Parameters

sec	Time in seconds.
usec	Additional time in microseconds.

---

The documentation for this class was generated from the following files:

• include/OsirisSDK/OTimeIndex.h
• src/OTimeIndex.cpp