RTI Connext Traditional C++ API Version 7.1.0

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. More...
 

Functions

static DDS_Time_t DDS_Time_t::from_micros (DDS_UnsignedLongLong microseconds)
 Creates a new time object from a time expressed in microseconds. More...
 
static DDS_Time_t DDS_Time_t::from_millis (DDS_UnsignedLongLong milliseconds)
 Creates a new time object from a time expressed in milliseconds. More...
 
static DDS_Time_t DDS_Time_t::from_nanos (DDS_UnsignedLongLong nanoseconds)
 Creates a new time object from a time expressed in nanoseconds. More...
 
static DDS_Time_t DDS_Time_t::from_seconds (DDS_UnsignedLong seconds)
 Creates a new time object from a time expressed in seconds. More...
 
DDS_Boolean DDS_Time_is_zero (const struct DDS_Time_t *time)
 Check if time is zero. More...
 
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. More...
 
static DDS_Duration_t DDS_Duration_t::from_millis (DDS_UnsignedLongLong milliseconds)
 Creates a new duration object from a duration expressed in milliseconds. More...
 
static DDS_Duration_t DDS_Duration_t::from_nanos (DDS_UnsignedLongLong nanoseconds)
 Creates a new duration object from a duration expressed in nanoseconds. More...
 
static DDS_Duration_t DDS_Duration_t::from_seconds (DDS_UnsignedLong seconds)
 Creates a new duration object from a duration expressed in seconds. More...
 
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

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

Detailed Description

Time and duration types and defines.

Macro Definition Documentation

◆ DDS_TIME_ZERO

#define DDS_TIME_ZERO

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

Function Documentation

◆ from_micros() [1/2]

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.

◆ from_millis() [1/2]

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.

◆ from_nanos() [1/2]

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.

◆ from_seconds() [1/2]

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_Time_is_zero()

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_Time_is_invalid()

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)

◆ from_micros() [2/2]

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.

◆ from_millis() [2/2]

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.

◆ from_nanos() [2/2]

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.

◆ from_seconds() [2/2]

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_Duration_is_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_Duration_is_auto()

DDS_Boolean DDS_Duration_is_auto ( const struct DDS_Duration_t duration)
Returns
DDS_BOOLEAN_TRUE if the given duration has auto value.

◆ DDS_Duration_is_zero()

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

◆ DDS_TIME_MAX

const struct DDS_Time_t DDS_TIME_MAX
extern

The maximum value of time.

◆ DDS_TIME_INVALID_SEC

const DDS_Long DDS_TIME_INVALID_SEC
extern

A sentinel indicating an invalid second of time.

◆ DDS_TIME_INVALID_NSEC

const DDS_UnsignedLong DDS_TIME_INVALID_NSEC
extern

A sentinel indicating an invalid nano-second of time.

◆ DDS_TIME_INVALID

const struct DDS_Time_t DDS_TIME_INVALID
extern

A sentinel indicating an invalid time.

◆ DDS_DURATION_INFINITE_SEC

const DDS_Long DDS_DURATION_INFINITE_SEC
extern

An infinite second period of time.

◆ DDS_DURATION_INFINITE_NSEC

const DDS_UnsignedLong DDS_DURATION_INFINITE_NSEC
extern

An infinite nano-second period of time.

◆ DDS_DURATION_INFINITE

const struct DDS_Duration_t DDS_DURATION_INFINITE
extern

An infinite period of time.

◆ DDS_DURATION_AUTO_SEC

const DDS_Long DDS_DURATION_AUTO_SEC
extern

An auto second period of time.

◆ DDS_DURATION_AUTO_NSEC

const DDS_UnsignedLong DDS_DURATION_AUTO_NSEC
extern

An auto nano-second period of time.

◆ DDS_DURATION_AUTO

const struct DDS_Duration_t DDS_DURATION_AUTO
extern

Duration is automatically assigned.

◆ DDS_DURATION_ZERO_SEC

const DDS_Long DDS_DURATION_ZERO_SEC
extern

A zero-length second period of time.

◆ DDS_DURATION_ZERO_NSEC

const DDS_UnsignedLong DDS_DURATION_ZERO_NSEC
extern

A zero-length nano-second period of time.

◆ DDS_DURATION_ZERO

const struct DDS_Duration_t DDS_DURATION_ZERO
extern

A zero-length period of time.