Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gazebo::SonarPlugin Class Reference

A sonar sensor plugin. More...

#include <SonarPlugin.hh>

Inheritance diagram for gazebo::SonarPlugin:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

sensors::SonarSensorPtr parentSensor
 The parent sensor. More...
 
- Protected Attributes inherited from gazebo::PluginT< SensorPlugin >
std::string filename
 Path to the shared library file. More...
 
std::string handleName
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Additional Inherited Members

- Public Types inherited from gazebo::PluginT< SensorPlugin >
typedef boost::shared_ptr
< SensorPlugin
TPtr
 plugin pointer type definition More...
 
- Static Public Member Functions inherited from gazebo::PluginT< SensorPlugin >
static TPtr Create (const std::string &_filename, const std::string &_name)
 a class method that creates a plugin from a file name. More...
 

Detailed Description

A sonar sensor plugin.

Constructor & Destructor Documentation

gazebo::SonarPlugin::SonarPlugin ( )

Constructor.

virtual gazebo::SonarPlugin::~SonarPlugin ( )
virtual

Destructor.

Member Function Documentation

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

Load the plugin.

Parameters
[in]_parentPointer to the parent sensor.
[in]_sdfSDF element for the plugin.

Implements gazebo::SensorPlugin.

virtual void gazebo::SonarPlugin::OnUpdate ( msgs::SonarStamped  _msg)
protectedvirtual

Update callback.

Overload this function in a child class.

Parameters
[in]_msgThe sonar ping message.

Member Data Documentation

sensors::SonarSensorPtr gazebo::SonarPlugin::parentSensor
protected

The parent sensor.


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