WindPlugin Class Reference

A plugin that simulates a simple wind model. More...

#include <WindPlugin.hh>

Inherits WorldPlugin.

Public Types
typedef boost::shared_ptr< WorldPlugin >	TPtr
	plugin pointer type definition

Public Member Functions
	WindPlugin ()
	Constructor.
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 ()
ignition::math::Vector3d	LinearVel (const physics::Wind *_wind, const physics::Entity *_entity)
	Get the global wind velocity.
virtual void	Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)
	Load function.
virtual void	Reset ()

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.

Protected Attributes
std::string	filename
	Path to the shared library file.
std::string	handleName
	Short name.
PluginType	type
	Type of plugin.

Detailed Description

A plugin that simulates a simple wind model.

Member Typedef Documentation

TPtr

typedef boost::shared_ptr<WorldPlugin> TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

WindPlugin()

WindPlugin

(

)

Constructor.

Member Function Documentation

Create()

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()

PluginType GetType ( ) const

inlineinherited

Returns the type of the plugin.

Returns

type of the plugin

Init()

virtual void Init ( )

inlinevirtualinherited

Reimplemented in ArrangePlugin, RubblePlugin, SimEventsPlugin, and StaticMapPlugin.

LinearVel()

ignition::math::Vector3d LinearVel	(	const physics::Wind *	_wind,
		const physics::Entity *	_entity )

Get the global wind velocity.

Parameters

[in]	_wind	Reference to the wind.
[in]	_wind	Pointer to an entity at which location the wind velocity is to be calculated.

Returns

Wind's velocity at entity's location.

Load()

virtual void Load ( physics::WorldPtr _world, sdf::ElementPtr _sdf )

virtual

Load function.

Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.

Parameters

[in]	_world	Pointer the World
[in]	_sdf	Pointer the the SDF element of the plugin.

Implements WorldPlugin.

LoadParam()

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.

Reset()

virtual void Reset ( )

inlinevirtualinherited

Reimplemented in ArrangePlugin.

Member Data Documentation

filename

std::string filename

protectedinherited

Path to the shared library file.

handleName

std::string handleName

protectedinherited

Short name.

type

PluginType type

protectedinherited

Type of plugin.

Referenced by WorldPlugin::WorldPlugin(), and RubblePlugin::Init().

---

The documentation for this class was generated from the following file:

• WindPlugin.hh