Server plugin base class. More...
#include <server_tools.h>
Public Member Functions | |
| CServerPluginBase (const std::string &name) | |
| Constructor. | |
| std::string | getName () |
| Get plugin name. | |
| virtual void | init (ros::NodeHandle &node_handle) |
| Initialize plugin - called in server constructor. | |
| virtual void | pause (bool bPause, ros::NodeHandle &node_handle) |
| Pause/resume plugin. All publishers and subscribers are disconnected on pause. | |
| void | publish (const ros::Time ×tamp) |
| Called when new scan was inserted and now all can be published. | |
| virtual void | reset () |
| Reset plugin content when reseting whole server. | |
| virtual | ~CServerPluginBase () |
| Virtual destructor. | |
Protected Member Functions | |
| virtual void | publishInternal (const ros::Time ×tamp)=0 |
| Publish data - virtual function. | |
| virtual bool | shouldPublish ()=0 |
| Should data be published. | |
Protected Attributes | |
| boost::mutex | m_lockMutex |
| Locking mutex. | |
| std::string | m_name |
| Plugin name. | |
Detailed Description
Server plugin base class.
Definition at line 126 of file server_tools.h.
Constructor & Destructor Documentation
| srs_env_model::CServerPluginBase::CServerPluginBase | ( | const std::string & | name | ) | [inline] |
Constructor.
Definition at line 132 of file server_tools.h.
| virtual srs_env_model::CServerPluginBase::~CServerPluginBase | ( | ) | [inline, virtual] |
Virtual destructor.
Definition at line 137 of file server_tools.h.
Member Function Documentation
| std::string srs_env_model::CServerPluginBase::getName | ( | ) | [inline] |
Get plugin name.
Definition at line 157 of file server_tools.h.
| virtual void srs_env_model::CServerPluginBase::init | ( | ros::NodeHandle & | node_handle | ) | [inline, virtual] |
Initialize plugin - called in server constructor.
Reimplemented in srs_env_model::CExampleCrawlerPlugin, srs_env_model::COctoMapPlugin, srs_env_model::CObjTreePlugin, srs_env_model::CCMapPlugin, srs_env_model::CPointCloudPlugin, srs_env_model::CIMarkersPlugin, srs_env_model::COldIMarkersPlugin, srs_env_model::CCollisionObjectPlugin, srs_env_model::CCompressedPointCloudPlugin, srs_env_model::CCollisionGridPlugin, srs_env_model::CLimitedPointCloudPlugin, srs_env_model::CMap2DPlugin, srs_env_model::CMarkerArrayPlugin, and srs_env_model::CExamplePlugin.
Definition at line 140 of file server_tools.h.
| virtual void srs_env_model::CServerPluginBase::pause | ( | bool | bPause, |
| ros::NodeHandle & | node_handle | ||
| ) | [inline, virtual] |
Pause/resume plugin. All publishers and subscribers are disconnected on pause.
Reimplemented in srs_env_model::COctoMapPlugin, srs_env_model::CObjTreePlugin, srs_env_model::CPointCloudPlugin, srs_env_model::CCMapPlugin, srs_env_model::CCollisionObjectPlugin, srs_env_model::CCompressedPointCloudPlugin, srs_env_model::CCollisionGridPlugin, srs_env_model::CLimitedPointCloudPlugin, srs_env_model::CMap2DPlugin, and srs_env_model::CMarkerArrayPlugin.
Definition at line 154 of file server_tools.h.
| void srs_env_model::CServerPluginBase::publish | ( | const ros::Time & | timestamp | ) | [inline] |
Called when new scan was inserted and now all can be published.
Definition at line 145 of file server_tools.h.
| virtual void srs_env_model::CServerPluginBase::publishInternal | ( | const ros::Time & | timestamp | ) | [protected, pure virtual] |
Publish data - virtual function.
Implemented in srs_env_model::CExampleCrawlerPlugin, srs_env_model::COctoMapPlugin, srs_env_model::CIMarkersPlugin, srs_env_model::COldIMarkersPlugin, srs_env_model::CPointCloudPlugin, srs_env_model::CObjTreePlugin, srs_env_model::CCMapPlugin, srs_env_model::CCompressedPointCloudPlugin, srs_env_model::CLimitedPointCloudPlugin, srs_env_model::CCollisionGridPlugin, srs_env_model::CCollisionObjectPlugin, srs_env_model::CMap2DPlugin, srs_env_model::CMarkerArrayPlugin, and srs_env_model::CExamplePlugin.
| virtual void srs_env_model::CServerPluginBase::reset | ( | ) | [inline, virtual] |
Reset plugin content when reseting whole server.
Reimplemented in srs_env_model::CExampleCrawlerPlugin, srs_env_model::CObjTreePlugin, and srs_env_model::CExamplePlugin.
Definition at line 151 of file server_tools.h.
| virtual bool srs_env_model::CServerPluginBase::shouldPublish | ( | ) | [protected, pure virtual] |
Should data be published.
Implemented in srs_env_model::CExampleCrawlerPlugin, srs_env_model::COctoMapPlugin, srs_env_model::CIMarkersPlugin, srs_env_model::COldIMarkersPlugin, srs_env_model::CPointCloudPlugin, srs_env_model::CCMapPlugin, srs_env_model::CObjTreePlugin, srs_env_model::CCompressedPointCloudPlugin, srs_env_model::CMarkerArrayPlugin, srs_env_model::CExamplePlugin, srs_env_model::CCollisionGridPlugin, srs_env_model::CMap2DPlugin, and srs_env_model::CCollisionObjectPlugin.
Member Data Documentation
boost::mutex srs_env_model::CServerPluginBase::m_lockMutex [protected] |
Locking mutex.
Definition at line 172 of file server_tools.h.
std::string srs_env_model::CServerPluginBase::m_name [protected] |
Plugin name.
Definition at line 169 of file server_tools.h.
The documentation for this class was generated from the following file: