Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ros::TimeBase< T, D > Class Template Reference

Base class for Time implementations. Provides storage, common functions and operator overloads. This should not need to be used directly. More...

#include <time.h>

Public Member Functions

T & fromNSec (uint64_t t)
 
T & fromSec (double t)
 
bool is_zero () const
 
bool isZero () const
 
const Time MAX
 
const WallTime MAX
 
const SteadyTime MAX
 
const Time MAX
 
const WallTime MAX
 
const SteadyTime MAX
 
const Time MIN
 
const WallTime MIN
 
const SteadyTime MIN
 
const Time MIN
 
const WallTime MIN
 
const SteadyTime MIN
 
bool operator!= (const T &rhs) const
 
operator+ (const D &rhs) const
 
T & operator+= (const D &rhs)
 
operator- (const D &rhs) const
 
operator- (const T &rhs) const
 
T & operator-= (const D &rhs)
 
bool operator< (const T &rhs) const
 
bool operator<= (const T &rhs) const
 
bool operator== (const T &rhs) const
 
bool operator> (const T &rhs) const
 
bool operator>= (const T &rhs) const
 
 TimeBase ()
 
 TimeBase (double t)
 
 TimeBase (uint32_t _sec, uint32_t _nsec)
 
boost::posix_time::ptime toBoost () const
 
uint64_t toNSec () const
 
double toSec () const
 
const Time UNINITIALIZED
 
const WallTime UNINITIALIZED
 
const SteadyTime UNINITIALIZED
 
const Time UNINITIALIZED
 
const WallTime UNINITIALIZED
 
const SteadyTime UNINITIALIZED
 
const Time ZERO
 
const WallTime ZERO
 
const SteadyTime ZERO
 
const Time ZERO
 
const WallTime ZERO
 
const SteadyTime ZERO
 

Public Attributes

uint32_t nsec
 
uint32_t sec
 

Static Public Attributes

static const T MAX
 Maximum representable time. More...
 
static const T MIN
 Minimum representable time. More...
 
static const T UNINITIALIZED
 Uninitialized time. More...
 
static const T ZERO
 Zero (invalid) time. More...
 

Detailed Description

template<class T, class D>
class ros::TimeBase< T, D >

Base class for Time implementations. Provides storage, common functions and operator overloads. This should not need to be used directly.

Definition at line 130 of file time.h.

Constructor & Destructor Documentation

◆ TimeBase() [1/3]

template<class T , class D >
ros::TimeBase< T, D >::TimeBase ( )
inline

Definition at line 137 of file time.h.

◆ TimeBase() [2/3]

template<class T , class D >
ros::TimeBase< T, D >::TimeBase ( uint32_t  _sec,
uint32_t  _nsec 
)
inline

Definition at line 138 of file time.h.

◆ TimeBase() [3/3]

template<class T , class D >
ros::TimeBase< T, D >::TimeBase ( double  t)
inlineexplicit

Definition at line 142 of file time.h.

Member Function Documentation

◆ fromNSec()

template<class T , class D >
T & ros::TimeBase< T, D >::fromNSec ( uint64_t  t)

Definition at line 100 of file impl/time.h.

◆ fromSec()

template<class T , class D >
T & ros::TimeBase< T, D >::fromSec ( double  t)

Definition at line 114 of file impl/time.h.

◆ is_zero()

template<class T , class D >
bool ros::TimeBase< T, D >::is_zero ( ) const
inline

Definition at line 162 of file time.h.

◆ isZero()

template<class T , class D >
bool ros::TimeBase< T, D >::isZero ( ) const
inline

Definition at line 161 of file time.h.

◆ MAX() [1/6]

const Time ros::TimeBase< Time, Duration >::MAX

Definition at line 113 of file src/time.cpp.

◆ MAX() [2/6]

Definition at line 118 of file src/time.cpp.

◆ MAX() [3/6]

Definition at line 123 of file src/time.cpp.

◆ MAX() [4/6]

const Time ros::TimeBase< Time, Duration >::MAX

Definition at line 224 of file time.h.

◆ MAX() [5/6]

Definition at line 261 of file time.h.

◆ MAX() [6/6]

Definition at line 300 of file time.h.

◆ MIN() [1/6]

const Time ros::TimeBase< Time, Duration >::MIN

Definition at line 114 of file src/time.cpp.

◆ MIN() [2/6]

Definition at line 119 of file src/time.cpp.

◆ MIN() [3/6]

Definition at line 124 of file src/time.cpp.

◆ MIN() [4/6]

const Time ros::TimeBase< Time, Duration >::MIN

Definition at line 225 of file time.h.

◆ MIN() [5/6]

Definition at line 262 of file time.h.

◆ MIN() [6/6]

Definition at line 301 of file time.h.

◆ operator!=()

template<class T , class D >
bool ros::TimeBase< T, D >::operator!= ( const T &  rhs) const
inline

Definition at line 149 of file time.h.

◆ operator+()

template<class T , class D >
T ros::TimeBase< T, D >::operator+ ( const D &  rhs) const

Definition at line 147 of file impl/time.h.

◆ operator+=()

template<class T , class D >
T & ros::TimeBase< T, D >::operator+= ( const D &  rhs)

Definition at line 160 of file impl/time.h.

◆ operator-() [1/2]

template<class T , class D >
T ros::TimeBase< T, D >::operator- ( const D &  rhs) const

Definition at line 141 of file impl/time.h.

◆ operator-() [2/2]

template<class T , class D >
D ros::TimeBase< T, D >::operator- ( const T &  rhs) const

Definition at line 134 of file impl/time.h.

◆ operator-=()

template<class T , class D >
T & ros::TimeBase< T, D >::operator-= ( const D &  rhs)

Definition at line 167 of file impl/time.h.

◆ operator<()

template<class T , class D >
bool ros::TimeBase< T, D >::operator< ( const T &  rhs) const

Definition at line 180 of file impl/time.h.

◆ operator<=()

template<class T , class D >
bool ros::TimeBase< T, D >::operator<= ( const T &  rhs) const

Definition at line 200 of file impl/time.h.

◆ operator==()

template<class T , class D >
bool ros::TimeBase< T, D >::operator== ( const T &  rhs) const

Definition at line 174 of file impl/time.h.

◆ operator>()

template<class T , class D >
bool ros::TimeBase< T, D >::operator> ( const T &  rhs) const

Definition at line 190 of file impl/time.h.

◆ operator>=()

template<class T , class D >
bool ros::TimeBase< T, D >::operator>= ( const T &  rhs) const

Definition at line 210 of file impl/time.h.

◆ toBoost()

template<class T , class D >
boost::posix_time::ptime ros::TimeBase< T, D >::toBoost

Definition at line 221 of file impl/time.h.

◆ toNSec()

template<class T , class D >
uint64_t ros::TimeBase< T, D >::toNSec ( ) const
inline

Definition at line 158 of file time.h.

◆ toSec()

template<class T , class D >
double ros::TimeBase< T, D >::toSec ( ) const
inline

Definition at line 155 of file time.h.

◆ UNINITIALIZED() [1/6]

const Time ros::TimeBase< Time, Duration >::UNINITIALIZED

Definition at line 116 of file src/time.cpp.

◆ UNINITIALIZED() [2/6]

const WallTime ros::TimeBase< WallTime, WallDuration >::UNINITIALIZED

Definition at line 121 of file src/time.cpp.

◆ UNINITIALIZED() [3/6]

const SteadyTime ros::TimeBase< SteadyTime, WallDuration >::UNINITIALIZED

Definition at line 126 of file src/time.cpp.

◆ UNINITIALIZED() [4/6]

const Time ros::TimeBase< Time, Duration >::UNINITIALIZED

Definition at line 227 of file time.h.

◆ UNINITIALIZED() [5/6]

const WallTime ros::TimeBase< WallTime, WallDuration >::UNINITIALIZED

Definition at line 264 of file time.h.

◆ UNINITIALIZED() [6/6]

const SteadyTime ros::TimeBase< SteadyTime, WallDuration >::UNINITIALIZED

Definition at line 303 of file time.h.

◆ ZERO() [1/6]

const Time ros::TimeBase< Time, Duration >::ZERO

Definition at line 115 of file src/time.cpp.

◆ ZERO() [2/6]

Definition at line 120 of file src/time.cpp.

◆ ZERO() [3/6]

Definition at line 125 of file src/time.cpp.

◆ ZERO() [4/6]

const Time ros::TimeBase< Time, Duration >::ZERO

Definition at line 226 of file time.h.

◆ ZERO() [5/6]

Definition at line 263 of file time.h.

◆ ZERO() [6/6]

Definition at line 302 of file time.h.

Member Data Documentation

◆ MAX

template<class T , class D >
const T ros::TimeBase< T, D >::MAX
static

Maximum representable time.

Definition at line 166 of file time.h.

◆ MIN

template<class T , class D >
const T ros::TimeBase< T, D >::MIN
static

Minimum representable time.

Definition at line 165 of file time.h.

◆ nsec

template<class T , class D >
uint32_t ros::TimeBase< T, D >::nsec

Definition at line 135 of file time.h.

◆ sec

template<class T , class D >
uint32_t ros::TimeBase< T, D >::sec

Definition at line 135 of file time.h.

◆ UNINITIALIZED

template<class T , class D >
const T ros::TimeBase< T, D >::UNINITIALIZED
static

Uninitialized time.

Definition at line 168 of file time.h.

◆ ZERO

template<class T , class D >
const T ros::TimeBase< T, D >::ZERO
static

Zero (invalid) time.

Definition at line 167 of file time.h.


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


rostime
Author(s): Josh Faust, Dirk Thomas
autogenerated on Sat Jun 17 2023 02:32:37