Privacy
An open-source, flexible 3D physical simulation framework
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
mars::interfaces::BaseSensor Class Reference

#include <sensor_bases.h>

Public Member Functions

 BaseSensor ()
 
virtual ~BaseSensor ()
 
 BaseSensor (unsigned long id, std::string name)
 
unsigned long getID () const
 
const std::string getName () const
 
virtual int getSensorData (double **data) const
 
virtual int getAsciiData (char *data) const
 
void getCoreExchange (core_objects_exchange *obj) const
 
virtual configmaps::ConfigMap createConfig () const
 

Static Public Member Functions

static BaseConfig * parseConfig (ControlCenter *control, configmaps::ConfigMap *config)
 

Public Attributes

unsigned long id
 
std::string name
 
unsigned long updateRate
 

Detailed Description

Definition at line 53 of file sensor_bases.h.

Constructor & Destructor Documentation

◆ BaseSensor() [1/2]

mars::interfaces::BaseSensor::BaseSensor ( )
inline

Definition at line 55 of file sensor_bases.h.

◆ ~BaseSensor()

virtual mars::interfaces::BaseSensor::~BaseSensor ( )
inlinevirtual

Definition at line 61 of file sensor_bases.h.

◆ BaseSensor() [2/2]

mars::interfaces::BaseSensor::BaseSensor ( unsigned long  id,
std::string  name 
)
inline

Definition at line 63 of file sensor_bases.h.

Member Function Documentation

◆ createConfig()

virtual configmaps::ConfigMap mars::interfaces::BaseSensor::createConfig ( ) const
inlinevirtual

Reimplemented in mars::sim::RotatingRaySensor, mars::sim::CameraSensor, mars::sim::RaySensor, mars::sim::Joint6DOFSensor, mars::sim::MultiLevelLaserRangeFinder, mars::sim::MotorCurrentSensor, mars::sim::NodeArraySensor, mars::sim::JointArraySensor, and mars::sim::NodeContactSensor.

Definition at line 103 of file sensor_bases.h.

◆ getAsciiData()

virtual int mars::interfaces::BaseSensor::getAsciiData ( char *  data) const
inlinevirtual

Reimplemented in mars::sim::HapticFieldSensor, mars::sim::Joint6DOFSensor, mars::sim::NodeArraySensor, mars::sim::JointArraySensor, mars::sim::MotorCurrentSensor, mars::sim::NodeContactSensor, mars::sim::JointAVGTorqueSensor, mars::sim::JointLoadSensor, mars::sim::NodeContactForceSensor, mars::sim::NodeRotationSensor, mars::sim::NodeAngularVelocitySensor, mars::sim::NodePositionSensor, mars::sim::NodeVelocitySensor, mars::sim::JointTorqueSensor, mars::sim::JointVelocitySensor, and mars::sim::NodeCOMSensor.

Definition at line 81 of file sensor_bases.h.

◆ getCoreExchange()

void mars::interfaces::BaseSensor::getCoreExchange ( core_objects_exchange *  obj) const
inline

Definition at line 85 of file sensor_bases.h.

◆ getID()

unsigned long mars::interfaces::BaseSensor::getID ( void  ) const
inline

Definition at line 69 of file sensor_bases.h.

◆ getName()

const std::string mars::interfaces::BaseSensor::getName ( ) const
inline

Definition at line 73 of file sensor_bases.h.

◆ getSensorData()

virtual int mars::interfaces::BaseSensor::getSensorData ( double **  data) const
inlinevirtual

Reimplemented in mars::interfaces::BasePolarIntersectionSensor, mars::sim::RotatingRaySensor, mars::sim::CameraSensor, mars::sim::ScanningSonar, mars::sim::HapticFieldSensor, mars::sim::RaySensor, mars::sim::Joint6DOFSensor, mars::sim::MultiLevelLaserRangeFinder, mars::sim::MotorPositionSensor, mars::sim::NodeArraySensor, mars::sim::JointArraySensor, mars::sim::RayGridSensor, mars::sim::MotorCurrentSensor, mars::sim::NodeContactSensor, mars::sim::JointAVGTorqueSensor, mars::sim::JointLoadSensor, mars::sim::NodeContactForceSensor, mars::sim::NodeRotationSensor, mars::sim::NodeAngularVelocitySensor, mars::sim::NodePositionSensor, mars::sim::NodeVelocitySensor, and mars::sim::NodeCOMSensor.

Definition at line 77 of file sensor_bases.h.

◆ parseConfig()

static BaseConfig* mars::interfaces::BaseSensor::parseConfig ( ControlCenter *  control,
configmaps::ConfigMap *  config 
)
inlinestatic

Definition at line 98 of file sensor_bases.h.

Member Data Documentation

◆ id

unsigned long mars::interfaces::BaseSensor::id

Definition at line 108 of file sensor_bases.h.

◆ name

std::string mars::interfaces::BaseSensor::name

Definition at line 109 of file sensor_bases.h.

◆ updateRate

unsigned long mars::interfaces::BaseSensor::updateRate

Definition at line 110 of file sensor_bases.h.

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