argos::CCI_Sensor Class Reference

The basic interface for all sensors. More...

#include <ci_sensor.h>

Inheritance diagram for argos::CCI_Sensor:

Collaboration diagram for argos::CCI_Sensor:

Public Types
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > >	TMap

Public Member Functions
virtual	~CCI_Sensor ()
	Class destructor. More...
virtual void	Init (TConfigurationNode &t_node)
	Initializes the sensor from the XML configuration tree. More...
virtual void	Reset ()
	Resets the sensor to the state it had just after Init(). More...
virtual void	Destroy ()
	Destroys the sensor. More...
virtual void	Enable ()
	Enables updating of sensor information in the event loop. More...
virtual void	Disable ()
	Disables updating of sensor information in the event loop. More...
bool	IsEnabled () const
bool	IsDisabled () const
Public Member Functions inherited from argos::CBaseConfigurableResource
virtual	~CBaseConfigurableResource ()
	Class destructor. More...

Detailed Description

The basic interface for all sensors.

Definition at line 34 of file ci_sensor.h.

Member Typedef Documentation

TMap

typedef std::map<std::string, CCI_Sensor*, std::less<std::string> > argos::CCI_Sensor::TMap

Definition at line 38 of file ci_sensor.h.

Constructor & Destructor Documentation

~CCI_Sensor()

virtual argos::CCI_Sensor::~CCI_Sensor ( )

inlinevirtual

Class destructor.

Definition at line 45 of file ci_sensor.h.

Member Function Documentation

Destroy()

virtual void argos::CCI_Sensor::Destroy ( )

inlinevirtual

Destroys the sensor.

This method is supposed to undo whatever was done in Init(). The default implementation of this method does nothing.

See also

Init()

Reset()

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CRangeAndBearingMediumSensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, and argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor.

Definition at line 71 of file ci_sensor.h.

Disable()

virtual void argos::CCI_Sensor::Disable ( )

inlinevirtual

Disables updating of sensor information in the event loop.

Reimplemented in argos::CRangeAndBearingMediumSensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor, and argos::CFootBotTurretEncoderDefaultSensor.

Definition at line 83 of file ci_sensor.h.

Enable()

virtual void argos::CCI_Sensor::Enable ( )

inlinevirtual

Enables updating of sensor information in the event loop.

For some sensors, this must be called before using them, others are enabled by default.

Reimplemented in argos::CRangeAndBearingMediumSensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor, and argos::CFootBotTurretEncoderDefaultSensor.

Definition at line 78 of file ci_sensor.h.

Init()

virtual void argos::CCI_Sensor::Init ( TConfigurationNode &  t_node )

inlinevirtual

Initializes the sensor from the XML configuration tree.

The default implementation of this method does nothing.

Parameters

t_node

The XML configuration tree relative to this sensor.

See also

Reset()

Destroy()

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CPrototypeJointsDefaultSensor, argos::CRangeAndBearingMediumSensor, argos::CRadiosDefaultSensor, argos::CProximityDefaultSensor, argos::CPositioningDefaultSensor, argos::CLightDefaultSensor, argos::CGroundRotZOnlySensor, argos::CDifferentialSteeringDefaultSensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor, argos::CCameraDefaultSensor, argos::CBatteryDefaultSensor, argos::CFootBotProximityDefaultSensor, argos::CFootBotMotorGroundRotZOnlySensor, argos::CFootBotLightRotZOnlySensor, argos::CFootBotDistanceScannerRotZOnlySensor, argos::CFootBotBaseGroundRotZOnlySensor, argos::CEyeBotProximityDefaultSensor, argos::CEyeBotLightRotZOnlySensor, and argos::CEPuckProximityDefaultSensor.

Definition at line 54 of file ci_sensor.h.

IsDisabled()

bool argos::CCI_Sensor::IsDisabled ( ) const

inline

Definition at line 86 of file ci_sensor.h.

IsEnabled()

bool argos::CCI_Sensor::IsEnabled ( ) const

inline

Definition at line 85 of file ci_sensor.h.

Reset()

virtual void argos::CCI_Sensor::Reset ( )

inlinevirtual

Resets the sensor to the state it had just after Init().

The default implementation of this method does nothing.

See also

Init()

Destroy()

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CPrototypeJointsDefaultSensor, argos::CRangeAndBearingMediumSensor, argos::CRadiosDefaultSensor, argos::CProximityDefaultSensor, argos::CPositioningDefaultSensor, argos::CLightDefaultSensor, argos::CGroundRotZOnlySensor, argos::CDifferentialSteeringDefaultSensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor, argos::CBatteryDefaultSensor, argos::CFootBotTurretEncoderDefaultSensor, argos::CFootBotProximityDefaultSensor, argos::CFootBotMotorGroundRotZOnlySensor, argos::CFootBotLightRotZOnlySensor, argos::CFootBotDistanceScannerRotZOnlySensor, argos::CFootBotBaseGroundRotZOnlySensor, argos::CEyeBotProximityDefaultSensor, argos::CEyeBotLightRotZOnlySensor, and argos::CEPuckProximityDefaultSensor.

Definition at line 62 of file ci_sensor.h.