Time Support

Time and duration types and defines. More...

Classes
struct	DDS::Time_t
	Type for time representation. More...
struct	DDS::Duration_t
	Type for duration representation. More...

Functions
static Time_t	DDS::Time_t::from_micros (System::UInt64 microseconds)
	Creates a new time object from a time expressed in microseconds.
static Time_t	DDS::Time_t::from_nanos (System::UInt64 nanoseconds)
	Creates a new time object from a time expressed in nanoseconds.
static Time_t	DDS::Time_t::from_millis (System::UInt64 milliseconds)
	Creates a new time object from a time expressed in milliseconds.
static Time_t	DDS::Time_t::from_seconds (System::UInt32 seconds)
	Creates a new time object from a time expressed in seconds.
System::Boolean	DDS::Time_t::is_zero ()
	Check if time is zero.
System::Boolean	DDS::Time_t::is_invalid_time ()
System::Boolean	DDS::Duration_t::is_infinite ()
System::Boolean	DDS::Duration_t::is_zero ()
System::Boolean	DDS::Duration_t::is_auto ()

Properties
static System::Int32	DDS::Time_t::TIME_INVALID_SEC [get]
	A sentinel indicating an invalid second of time.
static System::UInt32	DDS::Time_t::TIME_INVALID_NSEC [get]
	A sentinel indicating an invalid nano-second of time.
static Time_t	DDS::Time_t::TIME_ZERO [get]
	The default instant in time: zero seconds and zero nanoseconds.
static Time_t	DDS::Time_t::TIME_MAX [get]
	The maximum value of time.
static Time_t	DDS::Time_t::TIME_INVALID [get]
	A sentinel indicating an invalid time.
static System::Int32	DDS::Duration_t::DURATION_ZERO_SEC [get]
	A zero-length second period of time.
static System::UInt32	DDS::Duration_t::DURATION_ZERO_NSEC [get]
	A zero-length nano-second period of time.
static System::Int32	DDS::Duration_t::DURATION_INFINITE_SEC [get]
	An infinite second period of time.
static System::UInt32	DDS::Duration_t::DURATION_INFINITE_NSEC [get]
	An infinite nano-second period of time.
static Duration_t	DDS::Duration_t::DURATION_INFINITE [get]
	An infinite period of time.
static Duration_t	DDS::Duration_t::DURATION_ZERO [get]
	A zero-length period of time.
static System::Int32	DDS::Duration_t::DURATION_AUTO_SEC [get]
	An auto second period of time.
static System::UInt32	DDS::Duration_t::DURATION_AUTO_NSEC [get]
	An auto nano-second period of time.
static Duration_t	DDS::Duration_t::DURATION_AUTO [get]
	Duration is automatically assigned.

Detailed Description

Time and duration types and defines.

Function Documentation

static Time_t DDS::Time_t::from_micros ( System::UInt64  microseconds )

inlinestatic

Creates a new time object from a time expressed in microseconds.

In case of an overflow this function returns DDS::Time_t::TIME_MAX.

static Time_t DDS::Time_t::from_nanos ( System::UInt64  nanoseconds )

inlinestatic

Creates a new time object from a time expressed in nanoseconds.

In case of an overflow this function returns DDS::Time_t::TIME_MAX.

static Time_t DDS::Time_t::from_millis ( System::UInt64  milliseconds )

inlinestatic

Creates a new time object from a time expressed in milliseconds.

In case of an overflow this function returns DDS::Time_t::TIME_MAX.

static Time_t DDS::Time_t::from_seconds ( System::UInt32  seconds )

inlinestatic

Creates a new time object from a time expressed in seconds.

In case of an overflow this function returns DDS::Time_t::TIME_MAX.

System::Boolean DDS::Time_t::is_zero ( )

inline

Check if time is zero.

Returns

true if the given time is equal to DDS::Time_t::TIME_ZERO or false otherwise.

System::Boolean DDS::Time_t::is_invalid_time ( )

inline

Returns

true if the given time is not valid (i.e. is negative)

System::Boolean DDS::Duration_t::is_infinite ( )

inline

Returns

true if the given duration is of infinite length.

System::Boolean DDS::Duration_t::is_zero ( )

inline

Returns

true if the given duration is of zero length.

System::Boolean DDS::Duration_t::is_auto ( )

inline

Returns

true if the given duration has auto value.

Properties

System:: Int32 DDS::Time_t::TIME_INVALID_SEC

staticget

A sentinel indicating an invalid second of time.

System:: UInt32 DDS::Time_t::TIME_INVALID_NSEC

staticget

A sentinel indicating an invalid nano-second of time.

Time_t DDS::Time_t::TIME_ZERO

staticget

The default instant in time: zero seconds and zero nanoseconds.

Time_t DDS::Time_t::TIME_MAX

staticget

The maximum value of time.

Time_t DDS::Time_t::TIME_INVALID

staticget

A sentinel indicating an invalid time.

System:: Int32 DDS::Duration_t::DURATION_ZERO_SEC

staticget

A zero-length second period of time.

System:: UInt32 DDS::Duration_t::DURATION_ZERO_NSEC

staticget

A zero-length nano-second period of time.

System:: Int32 DDS::Duration_t::DURATION_INFINITE_SEC

staticget

An infinite second period of time.

System:: UInt32 DDS::Duration_t::DURATION_INFINITE_NSEC

staticget

An infinite nano-second period of time.

Duration_t DDS::Duration_t::DURATION_INFINITE

staticget

An infinite period of time.

Duration_t DDS::Duration_t::DURATION_ZERO

staticget

A zero-length period of time.

System:: Int32 DDS::Duration_t::DURATION_AUTO_SEC

staticget

An auto second period of time.

System:: UInt32 DDS::Duration_t::DURATION_AUTO_NSEC

staticget

An auto nano-second period of time.

Duration_t DDS::Duration_t::DURATION_AUTO

staticget

Duration is automatically assigned.