A plugin loaded within the gzserver on startup.
More...
#include <Plugin.hh>
Inherits PluginT< SystemPlugin >.
Inherited by ModelPropShop, RestUiPlugin, and RestWebPlugin.
|
| static TPtr | Create (const std::string &_filename, const std::string &_name) |
| | a class method that creates a plugin from a file name. More...
|
| |
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()
Destructor.
References NULL.
§ 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 = NULL |
|
) |
| |
|
pure virtual |
Load function.
Called before Gazebo is loaded. Must not block.
- Parameters
-
| _argc | Number of command line arguments. |
| _argv | Array of command line arguments. |
Implemented in RestUiPlugin, RestWebPlugin, and ModelPropShop.
§ 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:
