dds::core::Time Class Reference

#include "Time.hpp"

Public Member Functions
	Time ()
	Time (int64_t sec, uint32_t nanosec=0)
int	compare (const Time &that) const
uint32_t	nanosec () const
void	nanosec (uint32_t ns)
bool	operator!= (const Time &that) const
Time &	operator+= (const Duration &a_ti)
Time &	operator-= (const Duration &a_ti)
bool	operator< (const Time &that) const
bool	operator<= (const Time &that) const
bool	operator== (const Time &that) const
bool	operator> (const Time &that) const
bool	operator>= (const Time &that) const
int64_t	sec () const
void	sec (int64_t s)
int64_t	to_microsecs () const
int64_t	to_millisecs () const
double	to_secs () const

Static Public Member Functions
static const Time	from_microsecs (int64_t microseconds)
static const Time	from_millisecs (int64_t milliseconds)
static const Time	from_secs (double seconds)
static const Time	invalid ()

Detailed Description

Time represents a time value and can:

• Be incremented by Duration expressed as seconds, nanoseconds, milliseconds, or Duration objects.
• Be converted to and from Times expressed in milliseconds (or other units) as integer types.

Definition at line 42 of file Time.hpp.

Constructor & Destructor Documentation

Time() [1/2]

dds::core::Time::Time

(

)

Create a Time of zero seconds.

Time() [2/2]

dds::core::Time::Time ( int64_t  sec, uint32_t  nanosec = 0  )

explicit

Create a Time elapsing a specific amount of time.

Member Function Documentation

compare()

int dds::core::Time::compare

(

const Time &

that

)

const

Returns an integer indicating the result of a comparison of two Times: 1 if this Time is greater than the comparator (that) -1 if the Time is less than the comparator (that) 0 if the Time matches the comparator (that)

Parameters

that	Time to compare

Returns

comparison result

from_microsecs()

static const Time dds::core::Time::from_microsecs ( int64_t  microseconds )

static

Create a Time from a number of microseconds

Parameters

microseconds

number of microseconds

from_millisecs()

static const Time dds::core::Time::from_millisecs ( int64_t  milliseconds )

static

Create a Time from a number of milliseconds

Parameters

milliseconds

number of miliseconds

from_secs()

static const Time dds::core::Time::from_secs ( double  seconds )

static

Create a Time from a number of seconds

Parameters

seconds

number of seconds

invalid()

static const Time dds::core::Time::invalid ( )

static

nanosec() [1/2]

uint32_t dds::core::Time::nanosec

(

)

const

Returns

number of nanoseconds

nanosec() [2/2]

void dds::core::Time::nanosec

(

uint32_t

ns

)

Set number of nanoseconds

Parameters

ns	number of nanoseconds

operator!=()

bool dds::core::Time::operator!=

(

const Time &

that

)

const

Parameters

that	Time to compare

Returns

true if the Time is not equal to the comparator

operator+=()

Time& dds::core::Time::operator+=

(

const Duration &

a_ti

)

Parameters

a_ti	Duration to add

Returns

Time value + Duration

operator-=()

Time& dds::core::Time::operator-=

(

const Duration &

a_ti

)

Parameters

a_ti	Duration to subtract

Returns

Time value - Duration

operator<()

bool dds::core::Time::operator<

(

const Time &

that

)

const

Parameters

that	Time to compare

Returns

true if the Time is less than the comparator

operator<=()

bool dds::core::Time::operator<=

(

const Time &

that

)

const

Parameters

that	Time to compare

Returns

true if the Time is less than or equal to the comparator

operator==()

bool dds::core::Time::operator==

(

const Time &

that

)

const

Parameters

that	Time to compare

Returns

true if the Time is equal to the comparator

operator>()

bool dds::core::Time::operator>

(

const Time &

that

)

const

Parameters

that	Time to compare

Returns

true if the Time is greater than the comparator

operator>=()

bool dds::core::Time::operator>=

(

const Time &

that

)

const

Parameters

that	Time to compare

Returns

true if the Time is greater than or equal to the comparator

sec() [1/2]

int64_t dds::core::Time::sec

(

)

const

Returns

number of seconds

sec() [2/2]

void dds::core::Time::sec

(

int64_t

s

)

Set number of seconds

Parameters

s	number of seconds

to_microsecs()

int64_t dds::core::Time::to_microsecs

(

)

const

Returns this Time in micro-seconds.

Returns

this Time in micro-seconds

to_millisecs()

int64_t dds::core::Time::to_millisecs

(

)

const

Returns this Time in milliseconds.

Returns

this Time in milliseconds

to_secs()

double dds::core::Time::to_secs

(

)

const

Returns this Time in seconds.

Returns

this Time in seconds

---

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

• dds/core/Time.hpp