Public Types | Public Member Functions | Private Attributes | List of all members
swri::Timer Class Reference

#include <timer.h>

Public Types

enum  DIAGNOSTIC_FLAGS {
  DIAG_COUNT = 1 << 0, DIAG_RATE = 1 << 1, DIAG_DURATION = 1 << 2, DIAG_ALL = ~0,
  DIAG_MOST = DIAG_ALL ^ DIAG_COUNT
}
 

Public Member Functions

void appendDiagnostics (diagnostic_updater::DiagnosticStatusWrapper &status, const std::string &name, const int flags)
 
double desiredFrequency () const
 
ros::Duration desiredPeriod () const
 
ros::WallDuration maxDuration () const
 
double maxDurationMicroseconds () const
 
ros::Duration maxPeriod () const
 
double maxPeriodMilliseconds () const
 
ros::WallDuration meanDuration () const
 
double meanDurationMicroseconds () const
 
double meanFrequencyHz () const
 
ros::Duration meanPeriod () const
 
double meanPeriodMilliseconds () const
 
ros::WallDuration minDuration () const
 
double minDurationMicroseconds () const
 
ros::Duration minPeriod () const
 
double minPeriodMilliseconds () const
 
Timeroperator= (const Timer &other)
 
void resetStatistics ()
 
size_t ticks () const
 
 Timer ()
 
template<class T >
 Timer (ros::NodeHandle &nh, ros::Duration period, void(T::*callback)(const ros::TimerEvent &), T *obj)
 

Private Attributes

boost::shared_ptr< TimerImplimpl_
 

Detailed Description

Definition at line 38 of file timer.h.

Member Enumeration Documentation

◆ DIAGNOSTIC_FLAGS

Enumerator
DIAG_COUNT 
DIAG_RATE 
DIAG_DURATION 
DIAG_ALL 
DIAG_MOST 

Definition at line 82 of file timer.h.

Constructor & Destructor Documentation

◆ Timer() [1/2]

swri::Timer::Timer ( )
inline

Definition at line 98 of file timer.h.

◆ Timer() [2/2]

template<class T >
swri::Timer::Timer ( ros::NodeHandle nh,
ros::Duration  period,
void(T::*)(const ros::TimerEvent &)  callback,
T *  obj 
)
inline

Definition at line 107 of file timer.h.

Member Function Documentation

◆ appendDiagnostics()

void swri::Timer::appendDiagnostics ( diagnostic_updater::DiagnosticStatusWrapper status,
const std::string &  name,
const int  flags 
)
inline

Definition at line 228 of file timer.h.

◆ desiredFrequency()

double swri::Timer::desiredFrequency ( ) const
inline

Definition at line 130 of file timer.h.

◆ desiredPeriod()

ros::Duration swri::Timer::desiredPeriod ( ) const
inline

Definition at line 124 of file timer.h.

◆ maxDuration()

ros::WallDuration swri::Timer::maxDuration ( ) const
inline

Definition at line 202 of file timer.h.

◆ maxDurationMicroseconds()

double swri::Timer::maxDurationMicroseconds ( ) const
inline

Definition at line 220 of file timer.h.

◆ maxPeriod()

ros::Duration swri::Timer::maxPeriod ( ) const
inline

Definition at line 166 of file timer.h.

◆ maxPeriodMilliseconds()

double swri::Timer::maxPeriodMilliseconds ( ) const
inline

Definition at line 184 of file timer.h.

◆ meanDuration()

ros::WallDuration swri::Timer::meanDuration ( ) const
inline

Definition at line 190 of file timer.h.

◆ meanDurationMicroseconds()

double swri::Timer::meanDurationMicroseconds ( ) const
inline

Definition at line 208 of file timer.h.

◆ meanFrequencyHz()

double swri::Timer::meanFrequencyHz ( ) const
inline

Definition at line 148 of file timer.h.

◆ meanPeriod()

ros::Duration swri::Timer::meanPeriod ( ) const
inline

Definition at line 154 of file timer.h.

◆ meanPeriodMilliseconds()

double swri::Timer::meanPeriodMilliseconds ( ) const
inline

Definition at line 172 of file timer.h.

◆ minDuration()

ros::WallDuration swri::Timer::minDuration ( ) const
inline

Definition at line 196 of file timer.h.

◆ minDurationMicroseconds()

double swri::Timer::minDurationMicroseconds ( ) const
inline

Definition at line 214 of file timer.h.

◆ minPeriod()

ros::Duration swri::Timer::minPeriod ( ) const
inline

Definition at line 160 of file timer.h.

◆ minPeriodMilliseconds()

double swri::Timer::minPeriodMilliseconds ( ) const
inline

Definition at line 178 of file timer.h.

◆ operator=()

Timer & swri::Timer::operator= ( const Timer other)
inline

Definition at line 117 of file timer.h.

◆ resetStatistics()

void swri::Timer::resetStatistics ( )
inline

Definition at line 136 of file timer.h.

◆ ticks()

size_t swri::Timer::ticks ( ) const
inline

Definition at line 142 of file timer.h.

Member Data Documentation

◆ impl_

boost::shared_ptr<TimerImpl> swri::Timer::impl_
private

Definition at line 41 of file timer.h.


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


swri_roscpp
Author(s):
autogenerated on Sat Jan 21 2023 03:13:16