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.
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.
Public Member Functions inherited from gazebo::PluginT< SystemPlugin >
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.

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

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.

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:

• common/Plugin.hh