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...
 
- 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

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

virtual argos::CCI_Sensor::~CCI_Sensor ( )
inlinevirtual

Class destructor.

Definition at line 45 of file ci_sensor.h.

Member Function Documentation

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::CColoredBlobOmnidirectionalCameraRotZOnlySensor, and argos::CColoredBlobPerspectiveCameraDefaultSensor.

Definition at line 71 of file ci_sensor.h.