RTI Connext Traditional C++ API  Version 5.3.1
 All Classes Functions Variables Typedefs Enumerations Enumerator Groups Pages
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...
 

Macros

#define DDS_TIME_ZERO
 The default instant in time: zero seconds and zero nanoseconds.
 

Functions

static DDS_Time_t DDS_Time_t::from_micros (DDS_UnsignedLongLong microseconds)
 Creates a new time object from a time expressed in microseconds.
 
static DDS_Time_t DDS_Time_t::from_millis (DDS_UnsignedLongLong milliseconds)
 Creates a new time object from a time expressed in milliseconds.
 
static DDS_Time_t DDS_Time_t::from_nanos (DDS_UnsignedLongLong nanoseconds)
 Creates a new time object from a time expressed in nanoseconds.
 
static DDS_Time_t DDS_Time_t::from_seconds (DDS_UnsignedLong seconds)
 Creates a new time object from a time expressed in seconds.
 
DDS_Boolean DDS_Time_is_zero (const struct DDS_Time_t *time)
 Check if time is zero.
 
DDS_Boolean DDS_Time_is_invalid (const struct DDS_Time_t *time)
 
static DDS_Duration_t DDS_Duration_t::from_micros (DDS_UnsignedLongLong microseconds)
 Creates a new duration object from a duration expressed in microseconds.
 
static DDS_Duration_t DDS_Duration_t::from_millis (DDS_UnsignedLongLong milliseconds)
 Creates a new duration object from a duration expressed in milliseconds.
 
static DDS_Duration_t DDS_Duration_t::from_nanos (DDS_UnsignedLongLong nanoseconds)
 Creates a new duration object from a duration expressed in nanoseconds.
 
static DDS_Duration_t DDS_Duration_t::from_seconds (DDS_UnsignedLong seconds)
 Creates a new duration object from a duration expressed in seconds.
 
DDS_Boolean DDS_Duration_is_infinite (const struct DDS_Duration_t *duration)
 
DDS_Boolean DDS_Duration_is_auto (const struct DDS_Duration_t *duration)
 
DDS_Boolean DDS_Duration_is_zero (const struct DDS_Duration_t *duration)
 

Variables

struct DDS_Time_t DDS_TIME_MAX
 The maximum value of time.
 
const DDS_Long DDS_TIME_INVALID_SEC
 A sentinel indicating an invalid second of time.
 
const DDS_UnsignedLong DDS_TIME_INVALID_NSEC
 A sentinel indicating an invalid nano-second of time.
 
struct DDS_Time_t DDS_TIME_INVALID
 A sentinel indicating an invalid time.
 
const DDS_Long DDS_DURATION_INFINITE_SEC
 An infinite second period of time.
 
const DDS_UnsignedLong DDS_DURATION_INFINITE_NSEC
 An infinite nano-second period of time.
 
struct DDS_Duration_t DDS_DURATION_INFINITE
 An infinite period of time.
 
const DDS_Long DDS_DURATION_AUTO_SEC
 An auto second period of time.
 
const DDS_UnsignedLong DDS_DURATION_AUTO_NSEC
 An auto nano-second period of time.
 
struct DDS_Duration_t DDS_DURATION_AUTO
 Duration is automatically assigned.
 
const DDS_Long DDS_DURATION_ZERO_SEC
 A zero-length second period of time.
 
const DDS_UnsignedLong DDS_DURATION_ZERO_NSEC
 A zero-length nano-second period of time.
 
struct DDS_Duration_t DDS_DURATION_ZERO
 A zero-length period of time.
 

Detailed Description

Time and duration types and defines.

Macro Definition Documentation

#define DDS_TIME_ZERO

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

Function Documentation

static DDS_Time_t DDS_Time_t::from_micros ( DDS_UnsignedLongLong  microseconds)
static

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

In case of an overflow this function returns DDS_TIME_MAX.

static DDS_Time_t DDS_Time_t::from_millis ( DDS_UnsignedLongLong  milliseconds)
static

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

In case of an overflow this function returns DDS_TIME_MAX.

static DDS_Time_t DDS_Time_t::from_nanos ( DDS_UnsignedLongLong  nanoseconds)
static

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

In case of an overflow this function returns DDS_TIME_MAX.

static DDS_Time_t DDS_Time_t::from_seconds ( DDS_UnsignedLong  seconds)
static

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

In case of an overflow this function returns DDS_TIME_MAX.

DDS_Boolean DDS_Time_is_zero ( const struct DDS_Time_t time)

Check if time is zero.

Returns
DDS_BOOLEAN_TRUE if the given time is equal to DDS_TIME_ZERO or DDS_BOOLEAN_FALSE otherwise.
DDS_Boolean DDS_Time_is_invalid ( const struct DDS_Time_t time)
Returns
DDS_BOOLEAN_TRUE if the given time is not valid (i.e. is negative)
static DDS_Duration_t DDS_Duration_t::from_micros ( DDS_UnsignedLongLong  microseconds)
static

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

In case of an overflow this function returns DDS_DURATION_INFINITE.

static DDS_Duration_t DDS_Duration_t::from_millis ( DDS_UnsignedLongLong  milliseconds)
static

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

In case of an overflow this function returns DDS_DURATION_INFINITE.

static DDS_Duration_t DDS_Duration_t::from_nanos ( DDS_UnsignedLongLong  nanoseconds)
static

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

In case of an overflow this function returns DDS_DURATION_INFINITE.

static DDS_Duration_t DDS_Duration_t::from_seconds ( DDS_UnsignedLong  seconds)
static

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

In case of an overflow this function returns DDS_DURATION_INFINITE.

DDS_Boolean DDS_Duration_is_infinite ( const struct DDS_Duration_t duration)
Returns
DDS_BOOLEAN_TRUE if the given duration is of infinite length.
DDS_Boolean DDS_Duration_is_auto ( const struct DDS_Duration_t duration)
Returns
DDS_BOOLEAN_TRUE if the given duration has auto value.
DDS_Boolean DDS_Duration_is_zero ( const struct DDS_Duration_t duration)
Returns
DDS_BOOLEAN_TRUE if the given duration is of zero length.

Variable Documentation

struct DDS_Time_t DDS_TIME_MAX

The maximum value of time.

const DDS_Long DDS_TIME_INVALID_SEC

A sentinel indicating an invalid second of time.

const DDS_UnsignedLong DDS_TIME_INVALID_NSEC

A sentinel indicating an invalid nano-second of time.

struct DDS_Time_t DDS_TIME_INVALID

A sentinel indicating an invalid time.

const DDS_Long DDS_DURATION_INFINITE_SEC

An infinite second period of time.

const DDS_UnsignedLong DDS_DURATION_INFINITE_NSEC

An infinite nano-second period of time.

struct DDS_Duration_t DDS_DURATION_INFINITE

An infinite period of time.

const DDS_Long DDS_DURATION_AUTO_SEC

An auto second period of time.

const DDS_UnsignedLong DDS_DURATION_AUTO_NSEC

An auto nano-second period of time.

struct DDS_Duration_t DDS_DURATION_AUTO

Duration is automatically assigned.

const DDS_Long DDS_DURATION_ZERO_SEC

A zero-length second period of time.

const DDS_UnsignedLong DDS_DURATION_ZERO_NSEC

A zero-length nano-second period of time.

struct DDS_Duration_t DDS_DURATION_ZERO

A zero-length period of time.


RTI Connext Traditional C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc