<<extension>> Represents a point in time More...

#include <Time.hpp>

Public Member Functions
	Time ()
	Create a default Time object. The constructed Time object will represent 0 seconds and 0 nanoseconds.

	Time (int32_t sec, uint32_t nanosec=0)
	Create a Time object. The constructed Time object will represent the given amount of time.

	Time (const Time &other)
	Copy-construct a Time object from another Time object.

int32_t	sec () const
	Get the number of seconds that are represented by this Time object.

void	sec (int32_t s)
	Set the number of seconds that are represented by this Time object.

uint32_t	nanosec () const
	Get the number of nanoseconds that are represented by this Time object.

void	nanosec (uint32_t ns)
	Set the number of nanoseconds that are represented by this Time object.

int	compare (const Time &other) const
	Compare two Time objects.

bool	operator> (const Time &other) const
	Check if this Time is greater than another.

bool	operator>= (const Time &other) const
	Check if this Time is greater than or equal another.

bool	operator== (const Time &other) const
	Check if this Time of Time is equal to another.

bool	operator!= (const Time &other) const
	Check if this Time is not equal to another.

bool	operator<= (const Time &other) const
	Check if this Time is less than or equal another.

bool	operator< (const Time &other) const
	Check if this Time is less than another.

Time &	operator+= (const Duration &duration)
	Add a Duration to this Time object.

Time &	operator-= (const Duration &duration)
	Subtract a Duration from this Time object.

uint64_t	to_millisecs () const
	Convert this Time to milliseconds.

uint64_t	to_microsecs () const
	Convert this Time to microseconds.

double	to_secs () const
	Convert this Time to seconds.

Static Public Member Functions
static Time	invalid ()
	Get a Time object representing an invalid amount of time.

static Time	zero ()
	Get a Time object representing zero time.

static Time	maximum ()
	Get a Time object representing the maximum amount of time.

static Time	from_microsecs (uint64_t microseconds)
	Create a Time object from microseconds.

static Time	from_millisecs (uint64_t milliseconds)
	Create a Time object from milliseconds.

static Time	from_secs (double seconds)
	Create a Time object from seconds.

Related Functions
(Note that these are not member functions.)
Time	operator+ (const Time &time, const Duration &duration)
	Add a Time and a Duration together.

Time	operator+ (const Duration &duration, const Time &time)
	Add a Time and a Duration together.

Time	operator- (const Time &time, const Duration &duration)
	Subtract a Duration from a Time.

Detailed Description

<<extension>> Represents a point in time

Constructor & Destructor Documentation

dds::core::Time::Time ( )

Create a default Time object. The constructed Time object will represent 0 seconds and 0 nanoseconds.

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

explicit

Create a Time object. The constructed Time object will represent the given amount of time.

dds::core::Time::Time ( const Time & other )

Copy-construct a Time object from another Time object.

Member Function Documentation

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

static

Get a Time object representing an invalid amount of time.

Returns: const Time A Time object representing an invalid amount of time.

static Time dds::core::Time::zero ( )

static

Get a Time object representing zero time.

Returns: const Time A Time object representing zero time.

static Time dds::core::Time::maximum ( )

static

Get a Time object representing the maximum amount of time.

Returns: const Time A Time object representing the maximum amount of time.

static Time dds::core::Time::from_microsecs ( uint64_t microseconds )

static

Create a Time object from microseconds.

Parameters

microseconds How many microseconds this Time represent

Returns: Time A new instance of Time representing the given microseconds

static Time dds::core::Time::from_millisecs ( uint64_t milliseconds )

static

Create a Time object from milliseconds.

Parameters

milliseconds How many milliseconds this Time should represent

Returns: Time A new instance of Time representing the given milliseconds

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

static

Create a Time object from seconds.

Parameters

seconds How many seconds this Time should represent

Returns: Time A new instance of Time representing the given seconds

int32_t dds::core::Time::sec ( ) const

Get the number of seconds that are represented by this Time object.

Returns: int32_t The number of seconds

void dds::core::Time::sec ( int32_t s )

Set the number of seconds that are represented by this Time object.

Parameters

s	The number of seconds to set.

uint32_t dds::core::Time::nanosec ( ) const

Get the number of nanoseconds that are represented by this Time object.

Returns: uint32_t The number of nanoseconds

void dds::core::Time::nanosec ( uint32_t ns )

Set the number of nanoseconds that are represented by this Time object.

Parameters

ns	The number of nanoseconds to set.

int dds::core::Time::compare ( const Time & other ) const

Compare two Time objects.

Parameters