alrobotmodel  2.4.3.28-r2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Sim::ArrayDepthSensor Class Reference

ArrayDepthSensor is a class defining a sensor made of an array of depth sensors. More...

#include <alrobotmodel.h>

Public Member Functions

 ArrayDepthSensor ()
 creates an empty ArrayDepthSensor, you should not use this. More...
 
 ~ArrayDepthSensor ()
 destructor. More...
 
virtual int bufferSize () const
 returns the maximum size of the buffer of a measure from the ArrayDepthSensor in bits. More...
 
int width () const
 maximum width of the array captured in pixels. More...
 
int height () const
 maximum height of the array captured in pixels. More...
 
- Public Member Functions inherited from Sim::DCMSensor
 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...
 
- Public Member Functions inherited from Sim::Sensor
 Sensor ()
 creates an empty Sensor, you should not use this. More...
 
 ~Sensor ()
 destructor. More...
 
const Frameframe () 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

ArrayDepthSensor is a class defining a sensor made of an array of depth sensors.

Definition at line 1190 of file alrobotmodel.h.

Constructor & Destructor Documentation

Sim::ArrayDepthSensor::ArrayDepthSensor ( )

creates an empty ArrayDepthSensor, you should not use this.

Warning
The ArrayDepthSensor being empty, every access to this object will throw.
Sim::ArrayDepthSensor::~ArrayDepthSensor ( )

destructor.

Member Function Documentation

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

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

Implements Sim::DCMSensor.

int Sim::ArrayDepthSensor::height ( ) const

maximum height of the array captured in pixels.

int Sim::ArrayDepthSensor::width ( ) const

maximum width of the array captured in pixels.


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