Public Member Functions | List of all members
ros::WallDuration Class Reference

Duration representation for use with the WallTime class. More...

#include <duration.h>

Inheritance diagram for ros::WallDuration:
Inheritance graph
[legend]

Public Member Functions

bool sleep () const
 sleep for the amount of time specified by this Duration. If a signal interrupts the sleep, resleeps for the time remaining. More...
 
 WallDuration ()
 
 WallDuration (int32_t _sec, int32_t _nsec)
 
 WallDuration (double t)
 
 WallDuration (const Rate &)
 
- Public Member Functions inherited from ros::DurationBase< WallDuration >
 DurationBase ()
 
 DurationBase (int32_t _sec, int32_t _nsec)
 
 DurationBase (double t)
 
WallDurationfromNSec (int64_t t)
 
WallDurationfromSec (double t)
 
bool isZero () const
 
bool operator!= (const WallDuration &rhs) const
 
WallDuration operator* (double scale) const
 
WallDurationoperator*= (double scale)
 
WallDuration operator+ (const WallDuration &rhs) const
 
WallDurationoperator+= (const WallDuration &rhs)
 
WallDuration operator- (const WallDuration &rhs) const
 
WallDuration operator- () const
 
WallDurationoperator-= (const WallDuration &rhs)
 
bool operator< (const WallDuration &rhs) const
 
bool operator<= (const WallDuration &rhs) const
 
bool operator== (const WallDuration &rhs) const
 
bool operator> (const WallDuration &rhs) const
 
bool operator>= (const WallDuration &rhs) const
 
boost::posix_time::time_duration toBoost () const
 
int64_t toNSec () const
 
double toSec () const
 
 ~DurationBase ()
 

Additional Inherited Members

- Public Attributes inherited from ros::DurationBase< WallDuration >
int32_t nsec
 
int32_t sec
 

Detailed Description

Duration representation for use with the WallTime class.

ros::DurationBase provides most of its functionality.

Definition at line 136 of file duration.h.

Constructor & Destructor Documentation

◆ WallDuration() [1/4]

ros::WallDuration::WallDuration ( )
inline

Definition at line 139 of file duration.h.

◆ WallDuration() [2/4]

ros::WallDuration::WallDuration ( int32_t  _sec,
int32_t  _nsec 
)
inline

Definition at line 143 of file duration.h.

◆ WallDuration() [3/4]

ros::WallDuration::WallDuration ( double  t)
inlineexplicit

Definition at line 147 of file duration.h.

◆ WallDuration() [4/4]

ros::WallDuration::WallDuration ( const Rate rate)
explicit

Definition at line 43 of file src/duration.cpp.

Member Function Documentation

◆ sleep()

bool ros::WallDuration::sleep ( ) const

sleep for the amount of time specified by this Duration. If a signal interrupts the sleep, resleeps for the time remaining.

Returns
True if the desired sleep duration was met, false otherwise.

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


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


rostime
Author(s): Josh Faust
autogenerated on Mon Feb 28 2022 23:31:37