gazebo::SystemPlugin Class Reference

A plugin loaded within the gzserver on startup. More...

#include <Plugin.hh>

Inheritance diagram for gazebo::SystemPlugin:

Public Member Functions
	SystemPlugin ()
	Constructor. More...
virtual	~SystemPlugin ()
	Destructor. More...
virtual void	Init ()
	Initialize the plugin. More...
virtual void	Load (int _argc=0, char **_argv=NULL)=0
	Load function. More...
virtual void	Reset ()
	Override this method for custom plugin reset behavior. More...
Public Member Functions inherited from gazebo::PluginT< SystemPlugin >
	PluginT ()
	Constructor. More...
virtual	~PluginT ()
	Destructor. More...
std::string	GetFilename () const
	Get the name of the handler. More...
std::string	GetHandle () const
	Get the short name of the handler. More...
PluginType	GetType () const
	Returns the type of the plugin. More...

Additional Inherited Members
Public Types inherited from gazebo::PluginT< SystemPlugin >
typedef boost::shared_ptr < SystemPlugin >	TPtr
	plugin pointer type definition More...
Static Public Member Functions inherited from gazebo::PluginT< SystemPlugin >
static TPtr	Create (const std::string &_filename, const std::string &_name)
	a class method that creates a plugin from a file name. More...
Protected Attributes inherited from gazebo::PluginT< SystemPlugin >
std::string	filename
	Path to the shared library file. More...
std::string	handleName
	Short name. More...
PluginType	type
	Type of plugin. More...

Detailed Description

A plugin loaded within the gzserver on startup.

See reference

Todo:

how to make doxygen reference to the file gazebo.cc::g_plugins?

Constructor & Destructor Documentation

gazebo::SystemPlugin::SystemPlugin ( )

inline

Constructor.

References gazebo::SYSTEM_PLUGIN, and gazebo::PluginT< SystemPlugin >::type.

virtual gazebo::SystemPlugin::~SystemPlugin ( )

inlinevirtual

Destructor.

Member Function Documentation

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.

Implemented in gazebo::RestUiPlugin, gazebo::RestWebPlugin, and gazebo::ModelPropShop.

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:

• Plugin.hh