InstantIO::Time Class Reference
Helper class for exchanging time values.
More...
#include <InstantIO/Time.h>
List of all members.
Public Member Functions |
|
| Time () |
| | Constructor that initializes the Time object with the current time.
|
| | Time (double time) |
| | Constructor that initializes the Time object with a given time value.
|
| | Time (const Time &time) |
| | Constructor that initializes the Time object with the time value of another Time object.
|
| const Time & | operator= (const Time &time) |
| | Copy operator.
|
| void | set (double time) |
| | Sets the time value.
|
| void | set (Time time) |
| | Sets the time value.
|
| double | get () const |
| | Returns the time value.
|
Static Public Member Functions |
| static double | getCurrentTime () |
| | Returns the current time.
|
Friends |
| bool | operator== (const Time &t1, const Time &t2) |
| | Equality operator.
|
| bool | operator!= (const Time &t1, const Time &t2) |
| | Inequality operator.
|
| INSTANTIO_DLLMAPPING std::ostream & | operator<< (std::ostream &os, const Time &t) |
| | Output operator.
|
Detailed Description
Helper class for exchanging time values.
Time is a basic helper class for exchanging time values between different software components. It is not meant to be used directly by software components for representation of time values. Instead, software components should use their own, appropriate classes for handling time values. Only when sending time values to an OutSlot, or when receiving time values from an InSlot, the internal representation of time values should be converted to Time's. This ensures the interoperability between different software components that use different internal representations for time values.
- Author:
- Patrick Dähne
Constructor & Destructor Documentation
| InstantIO::Time::Time |
( |
double |
time |
) |
[inline] |
Constructor that initializes the Time object with a given time value.
- Parameters:
-
| time | The time value used to initialize the Time object. |
| InstantIO::Time::Time |
( |
const Time & |
time |
) |
[inline] |
Constructor that initializes the Time object with the time value of another Time object.
- Parameters:
-
| time | The other Time object. |
Member Function Documentation
| const Time& InstantIO::Time::operator= |
( |
const Time & |
time |
) |
[inline] |
Copy operator.
Sets the time value of this object to the time value of another Time object.
- Parameters:
-
| time | The other Time object. |
| void InstantIO::Time::set |
( |
double |
time |
) |
[inline] |
Sets the time value.
- Parameters:
-
| void InstantIO::Time::set |
( |
Time |
time |
) |
[inline] |
Sets the time value.
- Parameters:
-
| time | The Time object that contains the new time value. |
| double InstantIO::Time::get |
( |
|
) |
const [inline] |
Returns the time value.
- Returns:
- The time value.
| static double InstantIO::Time::getCurrentTime |
( |
|
) |
[static] |
Returns the current time.
- Returns:
- The current time.
Friends And Related Function Documentation
| bool operator== |
( |
const Time & |
t1, |
|
|
const Time & |
t2 | |
|
) |
| | [friend] |
Equality operator.
- Parameters:
-
| t1 | The first Time object. |
| t2 | The second Time object. |
- Returns:
- true when the Time objects are equal, false otherwise.
| bool operator!= |
( |
const Time & |
t1, |
|
|
const Time & |
t2 | |
|
) |
| | [friend] |
Inequality operator.
- Parameters:
-
| t1 | The first Time object. |
| t2 | The second Time object. |
- Returns:
- true when the Time objects are not equal, false otherwise.
| INSTANTIO_DLLMAPPING std::ostream& operator<< |
( |
std::ostream & |
os, |
|
|
const Time & |
t | |
|
) |
| | [friend] |
Output operator.
- Parameters:
-
| os | The output stream. |
| t | The Time object. |
- Returns:
- The output stream.
The documentation for this class was generated from the following file:
