Sim::DCMSensor Class Reference

DCMSensor defines a generic sensor which values are communicated through the DCM. More...

#include <alrobotmodel.h>

Public Member Functions
	DCMSensor ()
	creates an empty DCMSensor, you should not use this. More...
	~DCMSensor ()
	destructor More...
const std::vector< std::string > &	dcmKeys () const
	returns a vector of the full strings in the DCM concerning this sensor. This keys can be used directly to get data. More...
std::vector< std::string >	fullDcmKeys () const
	returns a vector of the full strings in the DCM concerning this More...
const std::vector< std::string > &	dcmStateKeys () const
	returns a vector of the strings in the DCM concerning the state keys of this sensor. More...
const std::vector< std::string > &	dcmCommandKeys () const
	returns a vector of the string in the DCM concerning the command keys of this sensor. These keys are useful to command the sensor More...
virtual int	bufferSize () const =0
	returns the maximum size of the buffer of a measure from the DCMSensor in bits. More...
Public Member Functions inherited from Sim::Sensor
	Sensor ()
	creates an empty Sensor, you should not use this. More...
	~Sensor ()
	destructor. More...
const Frame *	frame () const
	returns the Frame of the Sensor. More...
virtual const std::string &	name () const
	returns the name of the Sensor. More...
Type	type () const
	returns the Type of the Sensor. More...

Additional Inherited Members
Public Types inherited from Sim::Sensor
enum	Type {   ANGLE, COUPLED, SONAR, CAMERA,   FSR, INERTIAL, BUMPER, TORQUE,   ANGLE_SPEED, WHEEL_VELOCITY, TACTILE, DEPTH_INFRARED,   SINGLE_DEPTH, ARRAY_DEPTH, CAMERA_DEPTH, MICROPHONE }
	gives the type of the Sensor. More...
Public Attributes inherited from Sim::Sensor
class SensorImpl *	a_impl
	private implementation. More...

Detailed Description

DCMSensor defines a generic sensor which values are communicated through the DCM.

Definition at line 929 of file alrobotmodel.h.

Constructor & Destructor Documentation

Sim::DCMSensor::DCMSensor

(

)

creates an empty DCMSensor, you should not use this.

Warning

The DCMSensor being empty, every access to this object will throw.

Sim::DCMSensor::~DCMSensor

(

)

destructor

Member Function Documentation

virtual int Sim::DCMSensor::bufferSize ( ) const

pure virtual

returns the maximum size of the buffer of a measure from the DCMSensor in bits.

Implements Sim::Sensor.

Implemented in Sim::ArrayDepthSensor, Sim::SingleDepthSensor, Sim::TactileSensor, Sim::BumperSensor, Sim::SonarSensor, Sim::InertialSensor, Sim::FSRSensor, Sim::WheelVelocitySensor, Sim::AngleSpeedSensor, Sim::TorqueSensor, Sim::CoupledSensor, and Sim::AngleSensor.

const std::vector<std::string>& Sim::DCMSensor::dcmCommandKeys

(

)

const

returns a vector of the string in the DCM concerning the command keys of this sensor. These keys are useful to command the sensor

const std::vector<std::string>& Sim::DCMSensor::dcmKeys

(

)

const

returns a vector of the full strings in the DCM concerning this sensor. This keys can be used directly to get data.

const std::vector<std::string>& Sim::DCMSensor::dcmStateKeys

(

)

const

returns a vector of the strings in the DCM concerning the state keys of this sensor.

std::vector<std::string> Sim::DCMSensor::fullDcmKeys

(

)

const

returns a vector of the full strings in the DCM concerning this

Deprecated:

call dcmKeys instead

---

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

• /home/opennao/work/release-2.5/agility/alrobotmodel/libalrobotmodel/alrobotmodel/alrobotmodel.h