A mixin that can tell when a nodelet is being unloaded. More...
#include <stateful_nodelet.hpp>
Inheritance diagram for cras::StatefulNodelet< NodeletType >:
Public Member Functions | |
| bool | ok () const override |
Whether it is OK to continue sleeping. If false, a pending sleep() should stop as soon as possible. More... | |
| void | requestStop () override |
Call this function to request stopping this nodelet. ok() should return false after calling this. It terminates all ongoing sleeps called by this->sleep(). More... | |
| void | shutdown () |
| virtual | ~StatefulNodelet () |
 Public Member Functions inherited from nodelet::Nodelet | |
| void | init (const std::string &name, const M_string &remapping_args, const V_string &my_argv, ros::CallbackQueueInterface *st_queue=NULL, ros::CallbackQueueInterface *mt_queue=NULL) |
| Nodelet () | |
| virtual | ~Nodelet () |
| Public Member Functions inherited from cras::InterruptibleSleepInterface | |
| InterruptibleSleepInterface () | |
| virtual bool | sleep (const ::ros::Duration &duration) const |
Sleep for the given duration or until ok() returns false. More... | |
| virtual | ~InterruptibleSleepInterface () |
Destroy the object waiting for a pending sleep() call to finish. More... | |
Private Attributes | |
| volatile bool | shouldStop = false |
Whether requestStop() has been called. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from nodelet::Nodelet | |
| ros::CallbackQueueInterface & | getMTCallbackQueue () const |
| ros::NodeHandle & | getMTNodeHandle () const |
| ros::NodeHandle & | getMTPrivateNodeHandle () const |
| const V_string & | getMyArgv () const |
| const std::string & | getName () const |
| ros::NodeHandle & | getNodeHandle () const |
| ros::NodeHandle & | getPrivateNodeHandle () const |
| const M_string & | getRemappingArgs () const |
| ros::CallbackQueueInterface & | getSTCallbackQueue () const |
| std::string | getSuffixedName (const std::string &suffix) const |
| Protected Attributes inherited from cras::InterruptibleSleepInterface | |
| ::ros::WallDuration | pollDuration {0, 1000000} |
How long to wait between querying the ok() status and other conditions. More... | |
Detailed Description
template<typename NodeletType = ::nodelet::Nodelet>
class cras::StatefulNodelet< NodeletType >
A mixin that can tell when a nodelet is being unloaded.
- Template Parameters
-
NodeletType Type of the base nodelet.
Definition at line 49 of file stateful_nodelet.hpp.
Constructor & Destructor Documentation
◆ ~StatefulNodelet()
template<typename NodeletType = ::nodelet::Nodelet>
|
virtual |
Member Function Documentation
◆ ok()
template<typename NodeletType = ::nodelet::Nodelet>
|
overridevirtual |
Whether it is OK to continue sleeping. If false, a pending sleep() should stop as soon as possible.
- Returns
- Whether it is OK to continue.
- Note
- Always override this function as its default implementation returns false (used in case this function is called after the descendant parts of the objects have already been destructed).
Reimplemented from cras::InterruptibleSleepInterface.
◆ requestStop()
template<typename NodeletType = ::nodelet::Nodelet>
|
overridevirtual |
Call this function to request stopping this nodelet. ok() should return false after calling this. It terminates all ongoing sleeps called by this->sleep().
- Note
- This method is automatically called from the destructor (but rather call it as soon as you know the nodelet should be stopped).
Implements cras::StatefulNodeletInterface.
◆ shutdown()
template<typename NodeletType = ::nodelet::Nodelet>
| void cras::StatefulNodelet< NodeletType >::shutdown | ( | ) |
Member Data Documentation
◆ shouldStop
template<typename NodeletType = ::nodelet::Nodelet>
|
private |
Whether requestStop() has been called.
Definition at line 63 of file stateful_nodelet.hpp.
The documentation for this class was generated from the following file: