Tetrapod Project
gazebo::ContactPlugin Class Reference

A plugin for the contact sensors. More...

#include <contact_plugin.h>

Inheritance diagram for gazebo::ContactPlugin:
Collaboration diagram for gazebo::ContactPlugin:

Public Member Functions

 ContactPlugin ()
 Constructor. More...
 
virtual ~ContactPlugin ()
 Destructor. More...
 
virtual void Load (sensors::SensorPtr _sensor, sdf::ElementPtr _sdf)
 Load the sensor plugin. More...
 

Private Member Functions

virtual void OnUpdate ()
 Callback that receives the contact sensor's update signal. More...
 

Private Attributes

sensors::ContactSensorPtr parentSensor
 Pointer to the contact sensor. More...
 
event::ConnectionPtr updateConnection
 Connection that maintains a link between the contact sensor's updated signal and the OnUpdate callback. More...
 

Detailed Description

A plugin for the contact sensors.

Definition at line 39 of file contact_plugin.h.

Constructor & Destructor Documentation

◆ ContactPlugin()

gazebo::ContactPlugin::ContactPlugin ( )

Constructor.

Definition at line 36 of file contact_plugin.cpp.

◆ ~ContactPlugin()

gazebo::ContactPlugin::~ContactPlugin ( )
virtual

Destructor.

Definition at line 40 of file contact_plugin.cpp.

Member Function Documentation

◆ Load()

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.

Definition at line 44 of file contact_plugin.cpp.

◆ OnUpdate()

void gazebo::ContactPlugin::OnUpdate ( )
privatevirtual

Callback that receives the contact sensor's update signal.

Definition at line 66 of file contact_plugin.cpp.

Member Data Documentation

◆ parentSensor

sensors::ContactSensorPtr gazebo::ContactPlugin::parentSensor
private

Pointer to the contact sensor.

Definition at line 56 of file contact_plugin.h.

◆ updateConnection

event::ConnectionPtr gazebo::ContactPlugin::updateConnection
private

Connection that maintains a link between the contact sensor's updated signal and the OnUpdate callback.

Definition at line 60 of file contact_plugin.h.


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