A plugin with access to physics::Model.
More...
#include <Plugin.hh>
Inherits PluginT< ModelPlugin >.
Inherited by ActorPlugin, ActuatorPlugin, ArduCopterPlugin, AttachLightPlugin, BuoyancyPlugin, CartDemoPlugin, CessnaPlugin, DiffDrivePlugin, ElevatorPlugin, FlashLightPlugin, FollowerPlugin, GimbalSmall2dPlugin, GravityCompensationPlugin, HarnessPlugin, HydraDemoPlugin, InitialVelocityPlugin, JointControlPlugin, JointTrajectoryPlugin, KeysToCmdVelPlugin, KeysToJointsPlugin, LiftDragPlugin, LinearBatteryConsumerPlugin, LinearBatteryPlugin, LinkPlot3DPlugin, MudPlugin, PlaneDemoPlugin, RandomVelocityPlugin, RegionEventBoxPlugin, SkidSteerDrivePlugin, SphereAtlasDemoPlugin, TouchPlugin, TrackedVehiclePlugin, VariableGearboxPlugin, VehiclePlugin, and WheelSlipPlugin.
|
typedef boost::shared_ptr< ModelPlugin > | TPtr |
| plugin pointer type definition
|
|
|
| ModelPlugin () |
| Constructor.
|
|
virtual | ~ModelPlugin () |
| 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)=0 |
| Load function.
|
|
virtual void | Reset () |
| Override this method for custom plugin reset behavior.
|
|
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name.
|
|
|
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.
|
|
A plugin with access to physics::Model.
See reference.
◆ TPtr
plugin pointer type definition
◆ ModelPlugin()
◆ ~ModelPlugin()
◆ 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
◆ 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()
Returns the type of the plugin.
- Returns
- type of the plugin
◆ Init()
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.
◆ Load()
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. |
Implemented in ActorPlugin, ArduCopterPlugin, AttachLightPlugin, BuoyancyPlugin, CartDemoPlugin, CessnaPlugin, DiffDrivePlugin, ElevatorPlugin, FollowerPlugin, GimbalSmall2dPlugin, GravityCompensationPlugin, HarnessPlugin, InitialVelocityPlugin, JointControlPlugin, KeysToJointsPlugin, LiftDragPlugin, LinearBatteryConsumerPlugin, LinearBatteryPlugin, LinkPlot3DPlugin, MudPlugin, PlaneDemoPlugin, RandomVelocityPlugin, SkidSteerDrivePlugin, SphereAtlasDemoPlugin, TouchPlugin, VehiclePlugin, WheelSlipPlugin, KeysToCmdVelPlugin, SimpleTrackedVehiclePlugin, TrackedVehiclePlugin, WheelTrackedVehiclePlugin, ActuatorPlugin, RegionEventBoxPlugin, HydraDemoPlugin, JointTrajectoryPlugin, VariableGearboxPlugin, and FlashLightPlugin.
◆ 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. |
◆ 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. |
◆ Reset()
Override this method for custom plugin reset behavior.
Reimplemented in ActorPlugin, ElevatorPlugin, FollowerPlugin, InitialVelocityPlugin, LinearBatteryPlugin, RandomVelocityPlugin, SphereAtlasDemoPlugin, KeysToCmdVelPlugin, SimpleTrackedVehiclePlugin, TrackedVehiclePlugin, and WheelTrackedVehiclePlugin.
◆ filename
Path to the shared library file.
◆ handleName
◆ type
The documentation for this class was generated from the following file: