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

#include <subscriber.h>

Inheritance diagram for swri::Subscriber:
Inheritance graph
[legend]

Public Types

enum  DIAGNOSTIC_FLAGS {
  DIAG_CONNECTION = 1 << 0, DIAG_MSG_COUNT = 1 << 1, DIAG_TIMEOUT = 1 << 2, DIAG_LATENCY = 1 << 3,
  DIAG_RATE = 1 << 4, DIAG_ALL = ~0, DIAG_MOST = DIAG_ALL ^ DIAG_CONNECTION
}
 

Public Member Functions

ros::Duration age (const ros::Time &now=ros::TIME_MIN) const
 
double ageMilliseconds (const ros::Time &now=ros::TIME_MIN) const
 
double ageSeconds (const ros::Time &now=ros::TIME_MIN) const
 
void appendDiagnostics (diagnostic_updater::DiagnosticStatusWrapper &status, const std::string &name, const int flags)
 
bool blockTimeouts (bool block)
 
bool inTimeout ()
 
const std::string & mappedTopic () const
 
ros::Duration maxLatency () const
 
double maxLatencyMicroseconds () const
 
ros::Duration maxPeriod () const
 
double maxPeriodMilliseconds () const
 
double meanFrequencyHz () const
 
ros::Duration meanLatency () const
 
double meanLatencyMicroseconds () const
 
ros::Duration meanPeriod () const
 
double meanPeriodMilliseconds () const
 
int messageCount () const
 
ros::Duration minLatency () const
 
double minLatencyMicroseconds () const
 
ros::Duration minPeriod () const
 
double minPeriodMilliseconds () const
 
int numPublishers () const
 
Subscriber & operator= (const Subscriber &other)
 
void resetStatistics ()
 
void setTimeout (const ros::Duration &time_out)
 
void setTimeout (const double time_out)
 
 Subscriber ()
 
template<class M , class T >
 Subscriber (ros::NodeHandle &nh, const std::string &topic, uint32_t queue_size, void(T::*fp)(const boost::shared_ptr< M const > &), T *obj, const ros::TransportHints &transport_hints=ros::TransportHints())
 
template<class M >
 Subscriber (ros::NodeHandle &nh, const std::string &topic, uint32_t queue_size, const boost::function< void(const boost::shared_ptr< M const > &)> &callback, const ros::TransportHints &transport_hints=ros::TransportHints())
 
template<class M >
 Subscriber (ros::NodeHandle &nh, const std::string &topic, boost::shared_ptr< M const > *dest, const ros::TransportHints &transport_hints=ros::TransportHints())
 
ros::Duration timeout () const
 
int timeoutCount ()
 
bool timeoutEnabled () const
 
double timeoutMilliseconds () const
 
void timeoutParam (const ros::NodeHandle &nh, const std::string &parameter_name, const double default_value)
 
bool timeoutsBlocked () const
 
const std::string & unmappedTopic () const
 
virtual ~Subscriber ()
 

Private Attributes

boost::shared_ptr< SubscriberImpl > impl_
 

Detailed Description

Definition at line 61 of file subscriber.h.

Member Enumeration Documentation

◆ DIAGNOSTIC_FLAGS

enum swri::Subscriber::DIAGNOSTIC_FLAGS
Enumerator
DIAG_CONNECTION 
DIAG_MSG_COUNT 
DIAG_TIMEOUT 
DIAG_LATENCY 
DIAG_RATE 
DIAG_ALL 
DIAG_MOST 

Definition at line 181 of file subscriber.h.

Constructor & Destructor Documentation

◆ Subscriber() [1/4]

swri::Subscriber::Subscriber ( )
inline

Definition at line 209 of file subscriber.h.

◆ Subscriber() [2/4]

template<class M , class T >
swri::Subscriber::Subscriber ( ros::NodeHandle &  nh,
const std::string &  topic,
uint32_t  queue_size,
void(T::*)(const boost::shared_ptr< M const > &)  fp,
T *  obj,
const ros::TransportHints &  transport_hints = ros::TransportHints() 
)
inline

Definition at line 218 of file subscriber.h.

◆ Subscriber() [3/4]

template<class M >
swri::Subscriber::Subscriber ( ros::NodeHandle &  nh,
const std::string &  topic,
uint32_t  queue_size,
const boost::function< void(const boost::shared_ptr< M const > &)> &  callback,
const ros::TransportHints &  transport_hints = ros::TransportHints() 
)
inline

Definition at line 232 of file subscriber.h.

◆ Subscriber() [4/4]

template<class M >
swri::Subscriber::Subscriber ( ros::NodeHandle &  nh,
const std::string &  topic,
boost::shared_ptr< M const > *  dest,
const ros::TransportHints &  transport_hints = ros::TransportHints() 
)
inline

Definition at line 245 of file subscriber.h.

◆ ~Subscriber()

virtual swri::Subscriber::~Subscriber ( )
inlinevirtual

Definition at line 104 of file subscriber.h.

Member Function Documentation

◆ age()

ros::Duration swri::Subscriber::age ( const ros::Time &  now = ros::TIME_MIN) const
inline

Definition at line 312 of file subscriber.h.

◆ ageMilliseconds()

double swri::Subscriber::ageMilliseconds ( const ros::Time &  now = ros::TIME_MIN) const
inline

Definition at line 328 of file subscriber.h.

◆ ageSeconds()

double swri::Subscriber::ageSeconds ( const ros::Time &  now = ros::TIME_MIN) const
inline

Definition at line 322 of file subscriber.h.

◆ appendDiagnostics()

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

Definition at line 477 of file subscriber.h.

◆ blockTimeouts()

bool swri::Subscriber::blockTimeouts ( bool  block)
inline

Definition at line 435 of file subscriber.h.

◆ inTimeout()

bool swri::Subscriber::inTimeout ( )
inline

Definition at line 465 of file subscriber.h.

◆ mappedTopic()

const std::string & swri::Subscriber::mappedTopic ( ) const
inline

Definition at line 288 of file subscriber.h.

◆ maxLatency()

ros::Duration swri::Subscriber::maxLatency ( ) const
inline

Definition at line 346 of file subscriber.h.

◆ maxLatencyMicroseconds()

double swri::Subscriber::maxLatencyMicroseconds ( ) const
inline

Definition at line 364 of file subscriber.h.

◆ maxPeriod()

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

Definition at line 388 of file subscriber.h.

◆ maxPeriodMilliseconds()

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

Definition at line 406 of file subscriber.h.

◆ meanFrequencyHz()

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

Definition at line 376 of file subscriber.h.

◆ meanLatency()

ros::Duration swri::Subscriber::meanLatency ( ) const
inline

Definition at line 334 of file subscriber.h.

◆ meanLatencyMicroseconds()

double swri::Subscriber::meanLatencyMicroseconds ( ) const
inline

Definition at line 352 of file subscriber.h.

◆ meanPeriod()

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

Definition at line 370 of file subscriber.h.

◆ meanPeriodMilliseconds()

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

Definition at line 394 of file subscriber.h.

◆ messageCount()

int swri::Subscriber::messageCount ( ) const
inline

Definition at line 306 of file subscriber.h.

◆ minLatency()

ros::Duration swri::Subscriber::minLatency ( ) const
inline

Definition at line 340 of file subscriber.h.

◆ minLatencyMicroseconds()

double swri::Subscriber::minLatencyMicroseconds ( ) const
inline

Definition at line 358 of file subscriber.h.

◆ minPeriod()

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

Definition at line 382 of file subscriber.h.

◆ minPeriodMilliseconds()

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

Definition at line 400 of file subscriber.h.

◆ numPublishers()

int swri::Subscriber::numPublishers ( ) const
inline

Definition at line 294 of file subscriber.h.

◆ operator=()

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

Definition at line 256 of file subscriber.h.

◆ resetStatistics()

void swri::Subscriber::resetStatistics ( )
inline

Definition at line 300 of file subscriber.h.

◆ setTimeout() [1/2]

void swri::Subscriber::setTimeout ( const ros::Duration &  time_out)
inline

Definition at line 412 of file subscriber.h.

◆ setTimeout() [2/2]

void swri::Subscriber::setTimeout ( const double  time_out)
inline

Definition at line 418 of file subscriber.h.

◆ timeout()

ros::Duration swri::Subscriber::timeout ( ) const
inline

Definition at line 447 of file subscriber.h.

◆ timeoutCount()

int swri::Subscriber::timeoutCount ( )
inline

Definition at line 471 of file subscriber.h.

◆ timeoutEnabled()

bool swri::Subscriber::timeoutEnabled ( ) const
inline

Definition at line 453 of file subscriber.h.

◆ timeoutMilliseconds()

double swri::Subscriber::timeoutMilliseconds ( ) const
inline

Definition at line 459 of file subscriber.h.

◆ timeoutParam()

void swri::Subscriber::timeoutParam ( const ros::NodeHandle &  nh,
const std::string &  parameter_name,
const double  default_value 
)
inline

Definition at line 424 of file subscriber.h.

◆ timeoutsBlocked()

bool swri::Subscriber::timeoutsBlocked ( ) const
inline

Definition at line 441 of file subscriber.h.

◆ unmappedTopic()

const std::string & swri::Subscriber::unmappedTopic ( ) const
inline

Definition at line 282 of file subscriber.h.

Member Data Documentation

◆ impl_

boost::shared_ptr<SubscriberImpl> swri::Subscriber::impl_
private

Definition at line 69 of file subscriber.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