Plugin to control a elevator. More...
#include <ElevatorPlugin.hh>
Inherits ModelPlugin.
Public Types | |
typedef boost::shared_ptr< ModelPlugin > | TPtr |
plugin pointer type definition | |
Public Member Functions | |
ElevatorPlugin () | |
Constructor. | |
~ElevatorPlugin () | |
Destructor. | |
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. | |
virtual void | Init () |
Override this method for custom plugin initialization behavior. | |
virtual void | Load (physics::ModelPtr _model, sdf::ElementPtr _sdf) |
Load function. | |
void | MoveToFloor (const int _floor) |
Move to a particular floor. | |
virtual void | Reset () |
Override this method for custom plugin reset behavior. | |
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. | |
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. | |
Protected Attributes | |
std::string | filename |
Path to the shared library file. | |
std::string | handleName |
Short name. | |
PluginType | type |
Type of plugin. | |
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.
|
inherited |
plugin pointer type definition
ElevatorPlugin | ( | ) |
Constructor.
~ElevatorPlugin | ( | ) |
Destructor.
|
inlinestaticinherited |
a class method that creates a plugin from a file name.
It locates the shared library and loads it dynamically.
[in] | _filename | the path to the shared library. |
[in] | _name | short name of the plugin |
|
inlineinherited |
Get the name of the handler.
|
inlineinherited |
Get the short name of the handler.
|
inlineinherited |
Returns the type of the plugin.
|
inlinevirtualinherited |
Override this method for custom plugin initialization behavior.
Reimplemented in BuoyancyPlugin, CartDemoPlugin, DiffDrivePlugin, FollowerPlugin, GimbalSmall2dPlugin, HarnessPlugin, LinearBatteryPlugin, MudPlugin, PlaneDemoPlugin, SphereAtlasDemoPlugin, VehiclePlugin, KeysToCmdVelPlugin, SimpleTrackedVehiclePlugin, TrackedVehiclePlugin, and WheelTrackedVehiclePlugin.
|
virtual |
Load function.
Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.
[in] | _model | Pointer to the Model |
[in] | _sdf | Pointer to the SDF element of the plugin. |
Implements ModelPlugin.
|
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.
[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. |
|
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.
[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. |
void MoveToFloor | ( | const int | _floor | ) |
Move to a particular floor.
[in] | _floor | Number of the floor to move the elevator to. |
|
virtual |
Override this method for custom plugin reset behavior.
Reimplemented from ModelPlugin.
|
protectedinherited |
Path to the shared library file.
|
protectedinherited |
Short name.
|
protectedinherited |
Type of plugin.