ElevatorPlugin Class Reference

Plugin to control a elevator. More...

#include <ElevatorPlugin.hh>

Inherits ModelPlugin.

Public Types
typedef boost::shared_ptr< ModelPlugin >	TPtr
	plugin pointer type definition More...

Public Member Functions
	ElevatorPlugin ()
	Constructor. More...
	~ElevatorPlugin ()
	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 ()
	Override this method for custom plugin initialization behavior. More...
virtual void	Load (physics::ModelPtr _model, sdf::ElementPtr _sdf)
	Load function. More...
void	MoveToFloor (const int _floor)
	Move to a particular floor. 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 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. More...
void	LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) 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. 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

Plugin to control a elevator.

This plugin will listen for door and lift events on a specified topic.

///   <plugin filename="libElevatorPlugin.so" name="elevator_plugin">
///     <lift_joint>elevator::lift</lift_joint>
///     <door_joint>elevator::door</door_joint>
///     <floor_height>3.075</floor_height>
///
///     <!-- Time the elevator door will stay open in seconds -->
///     <door_wait_time>5</door_wait_time>
///
///     <topic>~/elevator</topic>
///   </plugin>
/// 

See worlds/elevator.world for a complete example.  

Member Typedef Documentation

TPtr

typedef boost::shared_ptr<ModelPlugin > TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

ElevatorPlugin()

ElevatorPlugin

(

)

Constructor.

~ElevatorPlugin()

~ElevatorPlugin

(

)

Destructor.

Member Function Documentation

Create()

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]	_filename	the path to the shared library.
[in]	_name	short name of the plugin

Returns

Shared Pointer to this class type

References PluginT< T >::filename, gzerr, and SingletonT< SystemPaths >::Instance().

GetFilename()

std::string GetFilename ( ) const

inlineinherited

Get the name of the handler.

References PluginT< T >::filename.

GetHandle()

std::string GetHandle ( ) const

inlineinherited

Get the short name of the handler.

References PluginT< T >::handleName.

GetType()

PluginType GetType ( ) const

inlineinherited

Returns the type of the plugin.

Returns

type of the plugin

References PluginT< T >::type.

Init()

virtual void Init ( )

inlinevirtualinherited

Override this method for custom plugin initialization behavior.

Reimplemented in KeysToCmdVelPlugin, BuoyancyPlugin, HarnessPlugin, FollowerPlugin, PlaneDemoPlugin, MudPlugin, CartDemoPlugin, VehiclePlugin, GimbalSmall2dPlugin, LinearBatteryPlugin, DiffDrivePlugin, and SphereAtlasDemoPlugin.

Load()

virtual void Load ( physics::ModelPtr  _model, sdf::ElementPtr  _sdf  )

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]	_model	Pointer to the Model
[in]	_sdf	Pointer to the SDF element of the plugin.

Implements ModelPlugin.

LoadParam() [1/2]

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]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

References gzmsg, and PluginT< T >::handleName.

LoadParam() [2/2]

void LoadParam ( sdf::ElementPtr &  _sdf, const std::string &  _name, std::string &  _target, const char *  _defaultValue  ) 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. String specialization to allow accepting const char* values for std::string parameters.

Parameters

[in]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

MoveToFloor()

void MoveToFloor

(

const int

_floor

)

Move to a particular floor.

Parameters

[in]

_floor

Number of the floor to move the elevator to.

Reset()

virtual void Reset ( )

virtual

Override this method for custom plugin reset behavior.

Reimplemented from ModelPlugin.

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.

---

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

• ElevatorPlugin.hh