A sonar sensor plugin.
More...
#include <SonarPlugin.hh>
Inherits SensorPlugin.
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name. More...
|
|
◆ TPtr
plugin pointer type definition
◆ SonarPlugin()
◆ ~SonarPlugin()
◆ Create()
static TPtr Create |
( |
const std::string & |
_filename, |
|
|
const std::string & |
_name |
|
) |
| |
|
inlinestaticinherited |
a class method that creates a plugin from a file name.
It locates the shared library and loads it dynamically.
- Parameters
-
[in] | _filename | the path to the shared library. |
[in] | _name | short name of the plugin |
- Returns
- Shared Pointer to this class type
◆ GetFilename()
std::string GetFilename |
( |
| ) |
const |
|
inlineinherited |
Get the name of the handler.
◆ GetHandle()
std::string GetHandle |
( |
| ) |
const |
|
inlineinherited |
Get the short name of the handler.
◆ GetType()
Returns the type of the plugin.
- Returns
- type of the plugin
◆ Init()
◆ Load()
Load the plugin.
- Parameters
-
[in] | _parent | Pointer to the parent sensor. |
[in] | _sdf | SDF element for the plugin. |
Implements SensorPlugin.
◆ OnUpdate()
virtual void OnUpdate |
( |
msgs::SonarStamped |
_msg | ) |
|
|
protectedvirtual |
Update callback.
Overload this function in a child class.
- Parameters
-
[in] | _msg | The sonar ping message. |
◆ Reset()
Override this method for custom plugin reset behavior.
◆ filename
Path to the shared library file.
◆ handleName
◆ parentSensor
◆ type
The documentation for this class was generated from the following file: