#include <example_plugin.h>
Public Member Functions | |
| CExampleCrawlerPlugin (const std::string &name="ExamplePlugin ") | |
| Constructor. Plugin name can be used for debug string output. | |
| virtual void | init (ros::NodeHandle &node_handle) |
| Basic plugin methods are the same. | |
| virtual void | reset () |
| Reset plugin. | |
| ~CExampleCrawlerPlugin () | |
| Destructor - do cleanup. | |
Protected Member Functions | |
| virtual void | handleFreeNode (tButServerOcTree::iterator &it, const SMapWithParameters &mp) |
| Handle free node - set its color to the green. | |
| virtual void | handleOccupiedNode (srs_env_model::tButServerOcTree::iterator &it, const SMapWithParameters &mp) |
| virtual void | handlePostNodeTraversal (const SMapWithParameters &mp) |
| Called when all nodes was visited. | |
| virtual void | newMapDataCB (SMapWithParameters &par) |
| Set used octomap frame id and timestamp. | |
| virtual void | publishInternal (const ros::Time ×tamp) |
| Publish data - virtual function. | |
| virtual bool | shouldPublish () |
Detailed Description
Simple crawler plugin example. As a crawler template parameter use octomap node type. Additionally this plugin uses data interface to store color used in handleOccupiedNode method.
Definition at line 72 of file example_plugin.h.
Constructor & Destructor Documentation
| srs_env_model::CExampleCrawlerPlugin::CExampleCrawlerPlugin | ( | const std::string & | name = "ExamplePlugin " | ) | [inline] |
Constructor. Plugin name can be used for debug string output.
Definition at line 79 of file example_plugin.h.
Destructor - do cleanup.
Definition at line 90 of file example_plugin.h.
Member Function Documentation
| virtual void srs_env_model::CExampleCrawlerPlugin::handleFreeNode | ( | tButServerOcTree::iterator & | it, |
| const SMapWithParameters & | mp | ||
| ) | [inline, protected, virtual] |
Handle free node - set its color to the green.
Definition at line 147 of file example_plugin.h.
| virtual void srs_env_model::CExampleCrawlerPlugin::handleOccupiedNode | ( | srs_env_model::tButServerOcTree::iterator & | it, |
| const SMapWithParameters & | mp | ||
| ) | [inline, protected, virtual] |
Hook that is called when traversing occupied nodes of the updated Octree. We set node color to the stored one.
Definition at line 139 of file example_plugin.h.
| virtual void srs_env_model::CExampleCrawlerPlugin::handlePostNodeTraversal | ( | const SMapWithParameters & | mp | ) | [inline, protected, virtual] |
Called when all nodes was visited.
Definition at line 155 of file example_plugin.h.
| virtual void srs_env_model::CExampleCrawlerPlugin::init | ( | ros::NodeHandle & | node_handle | ) | [inline, virtual] |
Basic plugin methods are the same.
Reimplemented from srs_env_model::CServerPluginBase.
Definition at line 93 of file example_plugin.h.
| virtual void srs_env_model::CExampleCrawlerPlugin::newMapDataCB | ( | SMapWithParameters & | par | ) | [inline, protected, virtual] |
Set used octomap frame id and timestamp.
Implements srs_env_model::COctomapCrawlerBase< tButServerOcTree::NodeType >.
Definition at line 101 of file example_plugin.h.
| virtual void srs_env_model::CExampleCrawlerPlugin::publishInternal | ( | const ros::Time & | timestamp | ) | [inline, protected, virtual] |
Publish data - virtual function.
Implements srs_env_model::CServerPluginBase.
Definition at line 129 of file example_plugin.h.
| virtual void srs_env_model::CExampleCrawlerPlugin::reset | ( | ) | [inline, virtual] |
Reset plugin.
Reimplemented from srs_env_model::CServerPluginBase.
Definition at line 96 of file example_plugin.h.
| virtual bool srs_env_model::CExampleCrawlerPlugin::shouldPublish | ( | ) | [inline, protected, virtual] |
We publish no data
Implements srs_env_model::CServerPluginBase.
Definition at line 134 of file example_plugin.h.
The documentation for this class was generated from the following file: