DDS-PSM-C++  1.0
ISO C++ API for OpenSplice DDS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | List of all members
dds::core::Duration Class Reference

#include <Duration.hpp>

Public Member Functions

 Duration ()
 
 Duration (int32_t sec, uint32_t nanosec=0)
 
 ~Duration ()
 
int compare (const Duration &that) const
 
uint32_t nanosec () const
 
void nanosec (uint32_t ns)
 
const Duration operator+ (const Duration &other) const
 
Durationoperator+= (const Duration &a_ti)
 
const Duration operator- (const Duration &other) const
 
Durationoperator-= (const Duration &a_ti)
 
bool operator< (const Duration &that) const
 
bool operator<= (const Duration &that) const
 
bool operator== (const Duration &that) const
 
bool operator> (const Duration &that) const
 
bool operator>= (const Duration &that) const
 
int32_t sec () const
 
void sec (int32_t s)
 
int64_t to_microsecs () const
 
int64_t to_millisecs () const
 
double to_secs () const
 

Static Public Member Functions

static const Duration from_microsecs (int64_t microseconds)
 
static const Duration from_millisecs (int64_t milliseconds)
 
static const Duration from_secs (double seconds)
 
static const Duration infinite ()
 
static const Duration zero ()
 

Detailed Description

This class represents a time interval.

Definition at line 29 of file Duration.hpp.

Constructor & Destructor Documentation

dds::core::Duration::Duration ( )

Create a duration elapsing zero seconds.

dds::core::Duration::Duration ( int32_t  sec,
uint32_t  nanosec = 0 
)
explicit

Create a duration elapsing a specific amount of time.

dds::core::Duration::~Duration ( )

Member Function Documentation

int dds::core::Duration::compare ( const Duration that) const
static const Duration dds::core::Duration::from_microsecs ( int64_t  microseconds)
static
static const Duration dds::core::Duration::from_millisecs ( int64_t  milliseconds)
static
static const Duration dds::core::Duration::from_secs ( double  seconds)
static
static const Duration dds::core::Duration::infinite ( )
static
uint32_t dds::core::Duration::nanosec ( ) const
void dds::core::Duration::nanosec ( uint32_t  ns)
const Duration dds::core::Duration::operator+ ( const Duration other) const
Duration& dds::core::Duration::operator+= ( const Duration a_ti)
const Duration dds::core::Duration::operator- ( const Duration other) const
Duration& dds::core::Duration::operator-= ( const Duration a_ti)
bool dds::core::Duration::operator< ( const Duration that) const
bool dds::core::Duration::operator<= ( const Duration that) const
bool dds::core::Duration::operator== ( const Duration that) const
bool dds::core::Duration::operator> ( const Duration that) const
bool dds::core::Duration::operator>= ( const Duration that) const
int32_t dds::core::Duration::sec ( ) const
void dds::core::Duration::sec ( int32_t  s)
int64_t dds::core::Duration::to_microsecs ( ) const

Returns this Duration in micro-seconds.

Returns
the duration in micro-seconds
int64_t dds::core::Duration::to_millisecs ( ) const

Returns this Duration in milli-seconds.

Returns
the duration in milliseconds
double dds::core::Duration::to_secs ( ) const

Returns this Duration in seconds.

Returns
the duration in seconds
static const Duration dds::core::Duration::zero ( )
static

The documentation for this class was generated from the following file: