A class which all plugins must inherit from.
More...
#include <common/common.hh>
|
typedef boost::shared_ptr< T > | TPtr |
| plugin pointer type definition
|
|
|
static TPtr | Create (const std::string &_filename, const std::string &_name) |
| a class method that creates a plugin from a file name.
|
|
|
template<typename V > |
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.
|
|
template<class T>
class gazebo::PluginT< T >
A class which all plugins must inherit from.
◆ TPtr
template<class T >
typedef boost::shared_ptr<T> TPtr |
plugin pointer type definition
◆ PluginT()
◆ ~PluginT()
◆ Create()
template<class T >
static TPtr Create |
( |
const std::string & | _filename, |
|
|
const std::string & | _name ) |
|
inlinestatic |
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()
template<class T >
std::string GetFilename |
( |
| ) |
const |
|
inline |
◆ GetHandle()
template<class T >
std::string GetHandle |
( |
| ) |
const |
|
inline |
◆ GetType()
◆ LoadParam() [1/2]
template<class T >
template<typename V >
void LoadParam |
( |
const sdf::ElementPtr & | _sdf, |
|
|
const std::string & | _name, |
|
|
V & | _target, |
|
|
V | _defaultValue = V() ) const |
|
inlineprotected |
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]
template<class T >
void LoadParam |
( |
sdf::ElementPtr & | _sdf, |
|
|
const std::string & | _name, |
|
|
std::string & | _target, |
|
|
const char * | _defaultValue ) const |
|
inlineprotected |
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. |
◆ filename
◆ handleName
◆ type
The documentation for this class was generated from the following file: