#include <ArrangePlugin.hh>
Inherits WorldPlugin.
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name. More...
|
|
|
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...
|
|
◆ Arrangement_M
Map of strings to Pose_M (arrangement map).
◆ Object_M
Map of strings to model pointers.
◆ ObjectPtr
◆ Pose_M
typedef std::map<std::string, ignition::math::Pose3d> Pose_M |
|
protected |
Map of strings to model poses.
◆ TPtr
plugin pointer type definition
◆ ArrangePlugin()
◆ ~ArrangePlugin()
◆ ArrangementCallback()
void ArrangementCallback |
( |
ConstGzStringPtr & |
_msg | ) |
|
Callback function which receives a requested arrangement name.
◆ 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()
◆ Load()
Load the plugin.
- Parameters
-
[in] | _world | Pointer to world |
[in] | _sdf | Pointer to the SDF configuration. |
Implements WorldPlugin.
◆ 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()
◆ SetArrangement()
bool SetArrangement |
( |
const std::string & |
_arrangement | ) |
|
Set up the arrangement with name given by input parameter.
- Parameters
-
[in] | _arrangement | Name of arrangement. |
- Returns
- True if arrangement was set successfully.
◆ arrangements
Information about arrangements.
◆ currentArrangementName
std::string currentArrangementName |
|
protected |
Current arrangement name.
◆ eventTopicName
std::string eventTopicName |
|
protected |
Topic to listen on for changing arrangments.
◆ filename
Path to the shared library file.
◆ handleName
◆ initialArrangementName
std::string initialArrangementName |
|
protected |
Initial arrangement name.
◆ node
Node for Gazebo transport.
◆ nodeIgn
ignition::transport::Node nodeIgn |
|
protected |
Ignition node for Gazebo transport.
◆ objects
◆ sdf
◆ sub
Subscriber for listening to changing arrangements.
◆ type
◆ world
The documentation for this class was generated from the following file: