RubblePlugin Class Reference

#include <RubblePlugin.hh>

Inherits WorldPlugin.

Public Types

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

Public Member Functions

 RubblePlugin ()
 Constructor. 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 (physics::WorldPtr _world, sdf::ElementPtr _sdf)
 Load the plugin. 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...
 

Member Typedef Documentation

typedef boost::shared_ptr<WorldPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

Constructor.

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

Initialize the plugin.

Reimplemented from WorldPlugin.

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

Load the plugin.

Parameters
[in]_worldPointer to world
[in]_sdfPointer to the SDF configuration.

Implements WorldPlugin.

virtual void Reset ( )
inlinevirtualinherited

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.


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