Time Support
[Infrastructure Module]

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

Defines

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

Functions

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


Define Documentation

#define DDS_TIME_ZERO

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


Function Documentation

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)

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

A sentinel indicating an invalid second of time.

A sentinel indicating an invalid nano-second of time.

A sentinel indicating an invalid time.

An infinite second period of time.

An infinite nano-second period of time.

An infinite period of time.

An auto second period of time.

An auto nano-second period of time.

Duration is automatically assigned.

A zero-length second period of time.

A zero-length nano-second period of time.

A zero-length period of time.


RTI Connext C++ API Version 4.5f Copyright © 17 Mar 2012 Real-Time Innovations, Inc