A plugin loaded within the gzserver on startup.
More...
#include <Plugin.hh>
|
| | SystemPlugin () |
| | Constructor.
|
| |
| virtual | ~SystemPlugin () |
| | Destructor.
|
| |
| virtual void | Init () |
| | Initialize the plugin.
|
| |
| virtual void | Load (int _argc=0, char **_argv=NULL)=0 |
| | Load function.
|
| |
| virtual void | Reset () |
| | Override this method for custom plugin reset behavior.
|
| |
| 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.
|
| |
|
| typedef SystemPlugin * | TPtr |
| | plugin pointer type definition
|
| |
| static TPtr | Create (const std::string &_filename, const std::string &_handle) |
| | a class method that creates a plugin from a file name.
|
| |
| std::string | filename |
| | Path to the shared library file.
|
| |
| std::string | handle |
| | Short name.
|
| |
| PluginType | type |
| | Type of plugin.
|
| |
A plugin loaded within the gzserver on startup.
See reference.
- Todo:
- how to make doxygen reference to the file gazebo.cc::g_plugins?
| gazebo::SystemPlugin::SystemPlugin |
( |
| ) |
|
|
inline |
| virtual gazebo::SystemPlugin::~SystemPlugin |
( |
| ) |
|
|
inlinevirtual |
| virtual void gazebo::SystemPlugin::Init |
( |
| ) |
|
|
inlinevirtual |
Initialize the plugin.
Called after Gazebo has been loaded. Must not block.
| virtual void gazebo::SystemPlugin::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. |
| virtual void gazebo::SystemPlugin::Reset |
( |
| ) |
|
|
inlinevirtual |
Override this method for custom plugin reset behavior.
The documentation for this class was generated from the following file:
Public Member Functions inherited from gazebo::PluginT< SystemPlugin >