Plugin to control a elevator. More...
#include <ElevatorPlugin.hh>
Public Member Functions | |
| ElevatorPlugin () | |
| Constructor. More... | |
| ~ElevatorPlugin () | |
| Destructor. 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... | |
 Public Member Functions inherited from gazebo::ModelPlugin | |
| ModelPlugin () | |
| Constructor. More... | |
| virtual | ~ModelPlugin () |
| Destructor. More... | |
| virtual void | Init () |
| Override this method for custom plugin initialization behavior. More... | |
| Public Member Functions inherited from gazebo::PluginT< ModelPlugin > | |
| PluginT () | |
| Constructor. More... | |
| virtual | ~PluginT () |
| 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... | |
Additional Inherited Members | |
| Public Types inherited from gazebo::PluginT< ModelPlugin > | |
| typedef boost::shared_ptr < ModelPlugin > | TPtr |
| plugin pointer type definition More... | |
| Static Public Member Functions inherited from gazebo::PluginT< ModelPlugin > | |
| 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 inherited from gazebo::PluginT< ModelPlugin > | |
| std::string | filename |
| Path to the shared library file. More... | |
| std::string | handleName |
| Short name. More... | |
| PluginType | type |
| Type of plugin. More... | |
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.
| gazebo::ElevatorPlugin::ElevatorPlugin | ( | ) |
Constructor.
| gazebo::ElevatorPlugin::~ElevatorPlugin | ( | ) |
Destructor.
|
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 gazebo::ModelPlugin.
| void gazebo::ElevatorPlugin::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 gazebo::ModelPlugin.