SonarPlugin Class Reference

A sonar sensor plugin. More...

#include <SonarPlugin.hh>

Inherits SensorPlugin.

Public Types
typedef boost::shared_ptr< SensorPlugin >	TPtr
	plugin pointer type definition More...

Public Member Functions
	SonarPlugin ()
	Constructor. More...
virtual	~SonarPlugin ()
	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...
virtual void	Init ()
	Override this method for custom plugin initialization behavior. More...
void	Load (sensors::SensorPtr _parent, sdf::ElementPtr _sdf)
	Load the plugin. More...
virtual void	Reset ()
	Override this method for custom plugin reset behavior. More...

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. More...

Protected Member Functions
virtual void	OnUpdate (msgs::SonarStamped _msg)
	Update callback. More...

Protected Attributes
std::string	filename
	Path to the shared library file. More...
std::string	handleName
	Short name. More...
sensors::SonarSensorPtr	parentSensor
	The parent sensor. More...
PluginType	type
	Type of plugin. More...

Detailed Description

A sonar sensor plugin.

Member Typedef Documentation

TPtr

typedef boost::shared_ptr<SensorPlugin > TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

SonarPlugin()

SonarPlugin

(

)

Constructor.

~SonarPlugin()

virtual ~SonarPlugin ( )

virtual

Destructor.

Member Function Documentation

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

PluginType GetType ( ) const

inlineinherited

Returns the type of the plugin.

Returns

type of the plugin

Init()

virtual void Init ( )

inlinevirtualinherited

Override this method for custom plugin initialization behavior.

Reimplemented in PressurePlugin.

Load()

void Load ( sensors::SensorPtr  _parent, sdf::ElementPtr  _sdf  )

virtual

Load the plugin.

Parameters

[in]	_parent	Pointer to the parent sensor.
[in]	_sdf	SDF element for the plugin.

Implements SensorPlugin.

OnUpdate()

virtual void OnUpdate ( msgs::SonarStamped  _msg )

protectedvirtual

Update callback.

Overload this function in a child class.

Parameters

[in]

_msg

The sonar ping message.

Reset()

virtual void Reset ( )

inlinevirtualinherited

Override this method for custom plugin reset behavior.

Member Data Documentation

filename

std::string filename

protectedinherited

Path to the shared library file.

handleName

std::string handleName

protectedinherited

Short name.

parentSensor

sensors::SonarSensorPtr parentSensor

protected

The parent sensor.

type

PluginType type

protectedinherited

Type of plugin.

---

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

• SonarPlugin.hh