Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Time

A class storing seconds & nanoseconds.
Contained in: FrameCPP::Version_3_4_5
Derived from: none
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/time.hh"


public function member index:

inline explicit Time(INT_4S sec = 0, INT_4U nsec = 0); Constructor.
inline Time(const Time& time); Copy Constructor.
inline INT_4U getNSec() const; Get the number of nanoseconds.
inline INT_4S getSec() const; Get the number of seconds.
bool operator !=(const Time& time) const; Not equal comparison.
const Time& operator *=(const double& d); Multiplication and assignment.
const Time& operator +=(const Time& time); Addition & assignment.
const Time& operator -=(const Time& time); Subtraction and assignment.
double operator /(const Time& time); Division.
const Time& operator /=(const double& d); Division and assignment.
bool operator <(const Time& time) const; Less than comparison.
bool operator <=(const Time& time) const; Less than or equal to comparison.
const Time& operator =(const Time& time); Assignment Operator.
bool operator ==(const Time& time) const; Equal comparison.
bool operator >(const Time& time) const; Greater than comparison.
bool operator >=(const Time& time) const; Greater than or equal to comparison.
INT_4U setNSec(INT_4U nsec); Set nanosecond residual
INT_4S setSec(INT_4S s); Set seconds
 

Description:

This is a very simple class storing time as integer seconds and nanoseconds.


Function Member Descriptions:


FrameCPP::Version_3_4_5::Time::Time - Constructor.


inline explicit Time(INT_4S sec = 0, INT_4U nsec = 0);

Parameters:
ParameterDescription
INT_4S secnumber of seconds. Default: 0
INT_4U nsecnumber of nanoseconds. Default: 0

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Time::Time - Copy Constructor.


inline Time(const Time& time);

Parameters:
ParameterDescription
const Time& timeObject to be copied.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Time::getNSec - Get the number of nanoseconds.


inline INT_4U getNSec() const;

Return value:
INT_4UThe number of nanoseconds.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Time::getSec - Get the number of seconds.


inline INT_4S getSec() const;

Return value:
INT_4SNumber of seconds.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Time::operator != - Not equal comparison.


bool operator !=(const Time& time) const;

Parameters:
ParameterDescription
const Time& timeThe object to compare with.

Return value:
boolTrue if this object's time is not equal to `time'.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator *= - Multiplication and assignment.


const Time& operator *=(const double& d);

Parameters:
ParameterDescription
const double& dMultiplier.

Return value:
const Time& timeThis object.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator += - Addition & assignment.


const Time& operator +=(const Time& time);

Parameters:
ParameterDescription
const Time& timeTime to be added.

Return value:
const Time& timeThis object.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator -= - Subtraction and assignment.


const Time& operator -=(const Time& time);

Parameters:
ParameterDescription
const Time& timeTime to be subtracted.

Return value:
const Time& timeThis object.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator / - Division.


double operator /(const Time& time);

Parameters:
ParameterDescription
const Time& timeDivider.

Return value:
doubleThis object time devided by `time'.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator /= - Division and assignment.


const Time& operator /=(const double& d);

Parameters:
ParameterDescription
const double& dDivider.

Return value:
const Time& timeThis object.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator < - Less than comparison.


bool operator <(const Time& time) const;

Parameters:
ParameterDescription
const Time& timeThe object to compare with.

Return value:
boolTrue if this object's time is less than `time'.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator <= - Less than or equal to comparison.


bool operator <=(const Time& time) const;

Parameters:
ParameterDescription
const Time& timeThe object to compare with.

Return value:
boolTrue if this object's time is less than ot equal to `time'.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator = - Assignment Operator.


const Time& operator =(const Time& time);

Parameters:
ParameterDescription
const Time& timeTime to be assigned to.

Return value:
const Time&This object.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator == - Equal comparison.


bool operator ==(const Time& time) const;
Determines whether two Time objects are equal.

Parameters:
ParameterDescription
const Time& timeThe object to compare with.

Return value:
boolTrue if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator > - Greater than comparison.


bool operator >(const Time& time) const;

Parameters:
ParameterDescription
const Time& timeThe object to compare with.

Return value:
boolTrue if this object's time is greater than `time'.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::operator >= - Greater than or equal to comparison.


bool operator >=(const Time& time) const;

Parameters:
ParameterDescription
const Time& timeThe object to compare with.

Return value:
boolTrue if this object's time is greater or equal to `time'.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::setNSec - Set nanosecond residual


INT_4U setNSec(INT_4U nsec);

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Time::setSec - Set seconds


INT_4S setSec(INT_4S s);

Exceptions:
ExceptionDescription
None.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Time::mNSec - Nanoseconds.

INT_4U mNSec;

FrameCPP::Version_3_4_5::Time::mSec - Seconds.

INT_4S mSec;