Public Member Functions | List of all members
gazebo::ContactPlugin Class Reference

A plugin for a contact sensor. More...

#include <ContactPlugin.hh>

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

Public Member Functions

 ContactPlugin ()
 Constructor. More...
 
virtual ~ContactPlugin ()
 Destructor. More...
 
virtual void Load (sensors::SensorPtr _sensor, sdf::ElementPtr _sdf)
 Load the sensor 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...
 

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

Detailed Description

A plugin for a contact sensor.

Inherit from this class to make your own contact plugin.

Constructor & Destructor Documentation

gazebo::ContactPlugin::ContactPlugin ( )

Constructor.

virtual gazebo::ContactPlugin::~ContactPlugin ( )
virtual

Destructor.

Member Function Documentation

virtual void gazebo::ContactPlugin::Load ( sensors::SensorPtr  _sensor,
sdf::ElementPtr  _sdf 
)
virtual

Load the sensor plugin.

Parameters
[in]_sensorPointer to the sensor that loaded this plugin.
[in]_sdfSDF element that describes the plugin.

Implements gazebo::SensorPlugin.


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