SystemPlugin Class Referenceabstract

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

#include <Plugin.hh>

Inherits PluginT< SystemPlugin >.

Inherited by ModelPropShop, RestUiPlugin, and RestWebPlugin.

Public Types

typedef boost::shared_ptr< SystemPluginTPtr
 plugin pointer type definition More...
 

Public Member Functions

 SystemPlugin ()
 Constructor. More...
 
virtual ~SystemPlugin ()
 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...
 
virtual void Init ()
 Initialize the plugin. More...
 
virtual void Load (int _argc=0, char **_argv=nullptr)=0
 Load function. More...
 
virtual void Reset ()
 Override this method for custom plugin reset behavior. More...
 

Static Public Member Functions

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

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?

Member Typedef Documentation

typedef boost::shared_ptr<SystemPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

SystemPlugin ( )
inline

Constructor.

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

virtual ~SystemPlugin ( )
inlinevirtual

Destructor.

Member Function Documentation

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]_filenamethe path to the shared library.
[in]_nameshort name of the plugin
Returns
Shared Pointer to this class type
std::string GetFilename ( ) const
inlineinherited

Get the name of the handler.

std::string GetHandle ( ) const
inlineinherited

Get the short name of the handler.

PluginType GetType ( ) const
inlineinherited

Returns the type of the plugin.

Returns
type of the plugin
virtual void Init ( )
inlinevirtual

Initialize the plugin.

Called after Gazebo has been loaded. Must not block.

virtual void Load ( int  _argc = 0,
char **  _argv = nullptr 
)
pure virtual

Load function.

Called before Gazebo is loaded. Must not block.

Parameters
_argcNumber of command line arguments.
_argvArray of command line arguments.

Implemented in RestWebPlugin, RestUiPlugin, and ModelPropShop.

virtual void Reset ( )
inlinevirtual

Override this method for custom plugin reset behavior.

Member Data Documentation

std::string filename
protectedinherited

Path to the shared library file.

std::string handleName
protectedinherited

Short name.

PluginType type
protectedinherited

Type of plugin.


The documentation for this class was generated from the following file: