A plugin loaded within the gzserver on startup.
More...
#include <Plugin.hh>
Inherits PluginT< SystemPlugin >.
Inherited by ModelPropShop, RestUiPlugin, RestWebPlugin, and StopWorldPlugin.
|
| SystemPlugin () |
| Constructor.
|
|
virtual | ~SystemPlugin () |
| Destructor.
|
|
std::string | GetFilename () const |
| Get the name of the handler.
|
|
std::string | GetHandle () const |
| Get the short name of the handler.
|
|
PluginType | GetType () const |
| Returns the type of the plugin.
|
|
virtual void | Init () |
| Initialize the plugin.
|
|
virtual void | Load (int _argc=0, char **_argv=nullptr)=0 |
| Load function.
|
|
virtual void | Reset () |
| Override this method for custom plugin reset behavior.
|
|
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name.
|
|
|
void | LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const |
| Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
|
|
void | LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) const |
| Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
|
|
A plugin loaded within the gzserver on startup.
See reference
- Todo
- how to make doxygen reference to the file gazebo.cc::g_plugins?
◆ TPtr
plugin pointer type definition
◆ SystemPlugin()
◆ ~SystemPlugin()
◆ 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()
Initialize the plugin.
Called after Gazebo has been loaded. Must not block.
◆ Load()
virtual void Load |
( |
int | _argc = 0, |
|
|
char ** | _argv = nullptr ) |
|
pure virtual |
◆ LoadParam() [1/2]
void LoadParam |
( |
const sdf::ElementPtr & | _sdf, |
|
|
const std::string & | _name, |
|
|
V & | _target, |
|
|
V | _defaultValue = V() ) const |
|
inlineprotectedinherited |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
A message is written using gzmsg reporting whether the default value was used or not.
- Parameters
-
[in] | _sdf | The SDF element of the plugin. |
[in] | _name | Name of a tag inside the SDF. |
[out] | _target | The reference to store the param value to. |
[in] | _defaultValue | The default value. |
◆ LoadParam() [2/2]
void LoadParam |
( |
sdf::ElementPtr & | _sdf, |
|
|
const std::string & | _name, |
|
|
std::string & | _target, |
|
|
const char * | _defaultValue ) const |
|
inlineprotectedinherited |
Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.
A message is written using gzmsg reporting whether the default value was used or not. String specialization to allow accepting const char* values for std::string parameters.
- Parameters
-
[in] | _sdf | The SDF element of the plugin. |
[in] | _name | Name of a tag inside the SDF. |
[out] | _target | The reference to store the param value to. |
[in] | _defaultValue | The default value. |
◆ Reset()
Override this method for custom plugin reset behavior.
◆ filename
Path to the shared library file.
◆ handleName
◆ type
The documentation for this class was generated from the following file: