Public Member Functions | Private Attributes | List of all members
cras::Resettable Class Referenceabstract

Interface for resettable nodes and nodelets. More...

#include <resettable.h>

Inheritance diagram for cras::Resettable:
Inheritance graph
[legend]

Public Member Functions

virtual void initRos (const ::ros::NodeHandle &pnh)
 Initialize the ROS part of the interface - subscriber to /reset and ~reset topics. More...
 
virtual void reset ()=0
 Do the resetting. Subclasses have to implement the logic. More...
 
 Resettable (const ::cras::LogHelperPtr &log)
 Create the resettable interface. To also wire up to the reset topics, call initRos(). More...
 
virtual ~Resettable ()
 

Private Attributes

::std::unique_ptr<::cras::ResettablePrivate > data
 Private implementation (PIMPL) data. More...
 

Detailed Description

Interface for resettable nodes and nodelets.

This class subscribes the following topics:

Definition at line 31 of file resettable.h.

Constructor & Destructor Documentation

◆ Resettable()

cras::Resettable::Resettable ( const ::cras::LogHelperPtr log)
explicit

Create the resettable interface. To also wire up to the reset topics, call initRos().

Parameters
[in]logThe logger to use for message logging.

◆ ~Resettable()

virtual cras::Resettable::~Resettable ( )
virtual

Member Function Documentation

◆ initRos()

virtual void cras::Resettable::initRos ( const ::ros::NodeHandle pnh)
virtual

Initialize the ROS part of the interface - subscriber to /reset and ~reset topics.

Parameters
[in]pnhThe (private) node handle to setup the interface for.

Reimplemented in cras::TimeJumpResettable.

◆ reset()

virtual void cras::Resettable::reset ( )
pure virtual

Member Data Documentation

◆ data

::std::unique_ptr<::cras::ResettablePrivate> cras::Resettable::data
private

Private implementation (PIMPL) data.

Definition at line 53 of file resettable.h.


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


cras_cpp_common
Author(s): Martin Pecka
autogenerated on Sun Jan 14 2024 03:48:14