#include <SimEventsPlugin.hh>

Inherits WorldPlugin.

Public Types

typedef boost::shared_ptr< WorldPluginTPtr
 plugin pointer type definition

Public Member Functions

virtual ~SimEventsPlugin ()
 Destrutor.
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.
void Init ()
 Called upon initialization.
void Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)
 Called when the world file is loaded.
virtual void Reset ()
void Update ()
 Called every simulation step.

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.

Protected Member Functions

void LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const
 Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

Protected Attributes

std::string filename
 Path to the shared library file.
std::string handleName
 Short name.
PluginType type
 Type of plugin.

Member Typedef Documentation

◆ TPtr

typedef boost::shared_ptr<WorldPlugin> TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

◆ ~SimEventsPlugin()

virtual ~SimEventsPlugin ( )
virtual

Destrutor.

Member Function Documentation

◆ Create()

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

◆ GetFilename()

std::string GetFilename ( ) const
inlineinherited

Get the name of the handler.

◆ GetHandle()

std::string GetHandle ( ) const
inlineinherited

Get the short name of the handler.

◆ GetType()

PluginType GetType ( ) const
inlineinherited

Returns the type of the plugin.

Returns
type of the plugin

◆ Init()

void Init ( )
virtual

Called upon initialization.

Reimplemented from WorldPlugin.

◆ Load()

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

Called when the world file is loaded.

Parameters
[in]_worldthe word
[in]_sdfthe plugin sdf element

Implements WorldPlugin.

◆ LoadParam()

void LoadParam ( const sdf::ElementPtr & _sdf,
const std::string & _name,
V & _target,
V _defaultValue = V() ) const
inlineprotectedinherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not.

Parameters
[in]_sdfThe SDF element of the plugin.
[in]_nameName of a tag inside the SDF.
[out]_targetThe reference to store the param value to.
[in]_defaultValueThe default value.

◆ Reset()

virtual void Reset ( )
inlinevirtualinherited

Reimplemented in ArrangePlugin.

◆ Update()

void Update ( )

Called every simulation step.

Member Data Documentation

◆ filename

std::string filename
protectedinherited

Path to the shared library file.

◆ handleName

std::string handleName
protectedinherited

Short name.

◆ type

PluginType type
protectedinherited

Type of plugin.

Referenced by WorldPlugin::WorldPlugin(), and RubblePlugin::Init().


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