RTI Connext .Net APIs  Version 5.3.1

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. More...
 
static Time_t DDS::Time_t::from_nanos (System::UInt64 nanoseconds)
 Creates a new time object from a time expressed in nanoseconds. More...
 
static Time_t DDS::Time_t::from_millis (System::UInt64 milliseconds)
 Creates a new time object from a time expressed in milliseconds. More...
 
static Time_t DDS::Time_t::from_seconds (System::UInt32 seconds)
 Creates a new time object from a time expressed in seconds. More...
 
System::Boolean DDS::Time_t::is_zero ()
 Check if time is zero. More...
 
System::Boolean DDS::Time_t::is_invalid_time ()
 
static Duration_t DDS::Duration_t::from_micros (System::UInt64 microseconds)
 Creates a new duration object from a duration expressed in microseconds. More...
 
static Duration_t DDS::Duration_t::from_nanos (System::UInt64 nanoseconds)
 Creates a new duration object from a duration expressed in nanoseconds. More...
 
static Duration_t DDS::Duration_t::from_millis (System::UInt64 milliseconds)
 Creates a new duration object from a duration expressed in milliseconds. More...
 
static Duration_t DDS::Duration_t::from_seconds (System::UInt32 seconds)
 Creates a new duration object from a duration expressed in seconds. More...
 
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. More...
 
static System::UInt32 DDS::Time_t::TIME_INVALID_NSEC [get]
 A sentinel indicating an invalid nano-second of time. More...
 
static Time_t DDS::Time_t::TIME_ZERO [get]
 The default instant in time: zero seconds and zero nanoseconds. More...
 
static Time_t DDS::Time_t::TIME_MAX [get]
 The maximum value of time. More...
 
static Time_t DDS::Time_t::TIME_INVALID [get]
 A sentinel indicating an invalid time. More...
 
static System::Int32 DDS::Duration_t::DURATION_ZERO_SEC [get]
 A zero-length second period of time. More...
 
static System::UInt32 DDS::Duration_t::DURATION_ZERO_NSEC [get]
 A zero-length nano-second period of time. More...
 
static System::Int32 DDS::Duration_t::DURATION_INFINITE_SEC [get]
 An infinite second period of time. More...
 
static System::UInt32 DDS::Duration_t::DURATION_INFINITE_NSEC [get]
 An infinite nano-second period of time. More...
 
static Duration_t DDS::Duration_t::DURATION_INFINITE [get]
 An infinite period of time. More...
 
static Duration_t DDS::Duration_t::DURATION_ZERO [get]
 A zero-length period of time. More...
 
static System::Int32 DDS::Duration_t::DURATION_AUTO_SEC [get]
 An auto second period of time. More...
 
static System::UInt32 DDS::Duration_t::DURATION_AUTO_NSEC [get]
 An auto nano-second period of time. More...
 
static Duration_t DDS::Duration_t::DURATION_AUTO [get]
 Duration is automatically assigned. More...
 

Detailed Description

Time and duration types and defines.

Function Documentation

◆ from_micros() [1/2]

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.

◆ from_nanos() [1/2]

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.

◆ from_millis() [1/2]

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.

◆ from_seconds() [1/2]

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.

◆ is_zero() [1/2]

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.

◆ is_invalid_time()

System::Boolean DDS::Time_t::is_invalid_time ( )
inline
Returns
true if the given time is not valid (i.e. is negative)

◆ from_micros() [2/2]

static Duration_t DDS::Duration_t::from_micros ( System::UInt64  microseconds)
inlinestatic

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

In case of an overflow this function returns DDS::Duration_t::DURATION_INFINITE.

◆ from_nanos() [2/2]

static Duration_t DDS::Duration_t::from_nanos ( System::UInt64  nanoseconds)
inlinestatic

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

In case of an overflow this function returns DDS::Duration_t::DURATION_INFINITE.

◆ from_millis() [2/2]

static Duration_t DDS::Duration_t::from_millis ( System::UInt64  milliseconds)
inlinestatic

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

In case of an overflow this function returns DDS::Duration_t::DURATION_INFINITE.

◆ from_seconds() [2/2]

static Duration_t DDS::Duration_t::from_seconds ( System::UInt32  seconds)
inlinestatic

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

In case of an overflow this function returns DDS::Duration_t::DURATION_INFINITE.

◆ is_infinite()

System::Boolean DDS::Duration_t::is_infinite ( )
inline
Returns
true if the given duration is of infinite length.

◆ is_zero() [2/2]

System::Boolean DDS::Duration_t::is_zero ( )
inline
Returns
true if the given duration is of zero length.

◆ is_auto()

System::Boolean DDS::Duration_t::is_auto ( )
inline
Returns
true if the given duration has auto value.

Properties

◆ TIME_INVALID_SEC

System:: Int32 DDS::Time_t::TIME_INVALID_SEC
staticget

A sentinel indicating an invalid second of time.

◆ TIME_INVALID_NSEC

System:: UInt32 DDS::Time_t::TIME_INVALID_NSEC
staticget

A sentinel indicating an invalid nano-second of time.

◆ TIME_ZERO

Time_t DDS::Time_t::TIME_ZERO
staticget

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

◆ TIME_MAX

Time_t DDS::Time_t::TIME_MAX
staticget

The maximum value of time.

◆ TIME_INVALID

Time_t DDS::Time_t::TIME_INVALID
staticget

A sentinel indicating an invalid time.

◆ DURATION_ZERO_SEC

System:: Int32 DDS::Duration_t::DURATION_ZERO_SEC
staticget

A zero-length second period of time.

◆ DURATION_ZERO_NSEC

System:: UInt32 DDS::Duration_t::DURATION_ZERO_NSEC
staticget

A zero-length nano-second period of time.

◆ DURATION_INFINITE_SEC

System:: Int32 DDS::Duration_t::DURATION_INFINITE_SEC
staticget

An infinite second period of time.

◆ DURATION_INFINITE_NSEC

System:: UInt32 DDS::Duration_t::DURATION_INFINITE_NSEC
staticget

An infinite nano-second period of time.

◆ DURATION_INFINITE

Duration_t DDS::Duration_t::DURATION_INFINITE
staticget

An infinite period of time.

◆ DURATION_ZERO

Duration_t DDS::Duration_t::DURATION_ZERO
staticget

A zero-length period of time.

Referenced by RTI.Connext.Queuing.QueueConsumer< TRep >::QueueConsumer().

◆ DURATION_AUTO_SEC

System:: Int32 DDS::Duration_t::DURATION_AUTO_SEC
staticget

An auto second period of time.

◆ DURATION_AUTO_NSEC

System:: UInt32 DDS::Duration_t::DURATION_AUTO_NSEC
staticget

An auto nano-second period of time.

◆ DURATION_AUTO

Duration_t DDS::Duration_t::DURATION_AUTO
staticget

Duration is automatically assigned.


RTI Connext .Net APIs Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc