Public Member Functions | Private Attributes | List of all members
hardware_interface::ForceTorqueSensorHandle Class Reference

A handle used to read the state of a force-torque sensor. More...

#include <force_torque_sensor_interface.h>

Public Member Functions

 ForceTorqueSensorHandle ()=default
 
 ForceTorqueSensorHandle (const std::string &name, const std::string &frame_id, const double *force, const double *torque)
 
 ForceTorqueSensorHandle (const std::string &name, const std::string &frame_id, double *force, double *torque)
 
const double * getForce () const
 
std::string getFrameId () const
 
std::string getName () const
 
const double * getTorque () const
 

Private Attributes

const double * force_ = {nullptr}
 
std::string frame_id_
 
std::string name_
 
const double * torque_ = {nullptr}
 

Detailed Description

A handle used to read the state of a force-torque sensor.

Definition at line 40 of file force_torque_sensor_interface.h.

Constructor & Destructor Documentation

◆ ForceTorqueSensorHandle() [1/3]

hardware_interface::ForceTorqueSensorHandle::ForceTorqueSensorHandle ( )
default

◆ ForceTorqueSensorHandle() [2/3]

hardware_interface::ForceTorqueSensorHandle::ForceTorqueSensorHandle ( const std::string &  name,
const std::string &  frame_id,
const double *  force,
const double *  torque 
)
inline
Parameters
nameThe name of the sensor
frame_idThe reference frame to which this sensor is associated
forceA pointer to the storage of the force value: a triplet (x,y,z)
torqueA pointer to the storage of the torque value: a triplet (x,y,z)

Definition at line 52 of file force_torque_sensor_interface.h.

◆ ForceTorqueSensorHandle() [3/3]

hardware_interface::ForceTorqueSensorHandle::ForceTorqueSensorHandle ( const std::string &  name,
const std::string &  frame_id,
double *  force,
double *  torque 
)
inline

Definition at line 63 of file force_torque_sensor_interface.h.

Member Function Documentation

◆ getForce()

const double* hardware_interface::ForceTorqueSensorHandle::getForce ( ) const
inline

Definition at line 75 of file force_torque_sensor_interface.h.

◆ getFrameId()

std::string hardware_interface::ForceTorqueSensorHandle::getFrameId ( ) const
inline

Definition at line 74 of file force_torque_sensor_interface.h.

◆ getName()

std::string hardware_interface::ForceTorqueSensorHandle::getName ( ) const
inline

Definition at line 73 of file force_torque_sensor_interface.h.

◆ getTorque()

const double* hardware_interface::ForceTorqueSensorHandle::getTorque ( ) const
inline

Definition at line 76 of file force_torque_sensor_interface.h.

Member Data Documentation

◆ force_

const double* hardware_interface::ForceTorqueSensorHandle::force_ = {nullptr}
private

Definition at line 81 of file force_torque_sensor_interface.h.

◆ frame_id_

std::string hardware_interface::ForceTorqueSensorHandle::frame_id_
private

Definition at line 80 of file force_torque_sensor_interface.h.

◆ name_

std::string hardware_interface::ForceTorqueSensorHandle::name_
private

Definition at line 79 of file force_torque_sensor_interface.h.

◆ torque_

const double* hardware_interface::ForceTorqueSensorHandle::torque_ = {nullptr}
private

Definition at line 82 of file force_torque_sensor_interface.h.


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


hardware_interface
Author(s): Wim Meeussen, Adolfo Rodriguez Tsouroukdissian
autogenerated on Tue Jun 22 2021 06:37:33