alrobotmodel  2.1.4.13
 All Classes Functions Variables Enumerations Enumerator Pages
Public Member Functions | List of all members
Sim::DCMSensor Class Referenceabstract

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
 
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.
 
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.
 
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
 
virtual int bufferSize () const =0
 returns the maximum size of the buffer of a measure from the DCMSensor in bits.
 
- Public Member Functions inherited from Sim::Sensor
 Sensor ()
 creates an empty Sensor, you should not use this. More...
 
 ~Sensor ()
 destructor.
 
const Frameframe () const
 returns the Frame of the Sensor.
 
virtual const std::string & name () const
 returns the name of the Sensor.
 
Type type () const
 returns the Type of the Sensor.
 

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.
 
- Public Attributes inherited from Sim::Sensor
class SensorImpl * a_impl
 private implementation.
 

Detailed Description

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

Definition at line 920 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.

Member Function Documentation

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: