WorldPlugin Class Referenceabstract

A plugin with access to physics::World. More...

#include <common/common.hh>

Inherits PluginT< WorldPlugin >.

Inherited by ArrangePlugin, RazerHydra, RubblePlugin, SimEventsPlugin, TransporterPlugin, and WindPlugin.

Public Types

typedef boost::shared_ptr
< WorldPlugin
TPtr
 plugin pointer type definition More...
 

Public Member Functions

 WorldPlugin ()
 Constructor. More...
 
virtual ~WorldPlugin ()
 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 ()
 
virtual void Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)=0
 Load function. More...
 
virtual void Reset ()
 

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 with access to physics::World.

See reference.

Member Typedef Documentation

typedef boost::shared_ptr<WorldPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

WorldPlugin ( )
inline

Constructor.

References PluginT< WorldPlugin >::type, and gazebo::WORLD_PLUGIN.

virtual ~WorldPlugin ( )
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

Reimplemented in ArrangePlugin, SimEventsPlugin, and RubblePlugin.

virtual void Load ( physics::WorldPtr  _world,
sdf::ElementPtr  _sdf 
)
pure virtual

Load function.

Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.

Parameters
[in]_worldPointer the World
[in]_sdfPointer the the SDF element of the plugin.

Implemented in TransporterPlugin, WindPlugin, ArrangePlugin, SimEventsPlugin, RubblePlugin, and RazerHydra.

virtual void Reset ( )
inlinevirtual

Reimplemented in ArrangePlugin.

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.

Referenced by WorldPlugin::WorldPlugin().


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