argos::CBatteryDefaultSensor Class Reference

#include <battery_default_sensor.h>

Inheritance diagram for argos::CBatteryDefaultSensor:
Collaboration diagram for argos::CBatteryDefaultSensor:

Public Member Functions

 CBatteryDefaultSensor ()
 
virtual ~CBatteryDefaultSensor ()
 
virtual void SetRobot (CComposableEntity &c_entity)
 Sets the entity associated to this sensor. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the sensor from the XML configuration tree. More...
 
virtual void Update ()
 Updates the state of the entity associated to this sensor. More...
 
virtual void Reset ()
 Resets the sensor to the state it had just after Init(). More...
 
- Public Member Functions inherited from argos::CSimulatedSensor
virtual ~CSimulatedSensor ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CCI_BatterySensor
virtual ~CCI_BatterySensor ()
 
const SReadingGetReading () const
 
- Public Member Functions inherited from argos::CCI_Sensor
virtual ~CCI_Sensor ()
 Class destructor. More...
 
virtual void Destroy ()
 Destroys the sensor. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Protected Attributes

CEmbodiedEntitym_pcEmbodiedEntity
 Reference to embodied entity associated to this sensor. More...
 
CBatteryEquippedEntitym_pcBatteryEntity
 Reference to battery sensor equipped entity associated to this sensor. More...
 
CRandom::CRNGm_pcRNG
 Random number generator. More...
 
bool m_bAddNoise
 Whether to add noise or not. More...
 
CRange< Realm_cNoiseRange
 Noise range on battery level. More...
 
- Protected Attributes inherited from argos::CCI_BatterySensor
SReading m_sReading
 

Additional Inherited Members

- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 

Detailed Description

Definition at line 27 of file battery_default_sensor.h.

Constructor & Destructor Documentation

argos::CBatteryDefaultSensor::CBatteryDefaultSensor ( )

Definition at line 24 of file battery_default_sensor.cpp.

virtual argos::CBatteryDefaultSensor::~CBatteryDefaultSensor ( )
inlinevirtual

Definition at line 34 of file battery_default_sensor.h.

Member Function Documentation

void argos::CBatteryDefaultSensor::Init ( TConfigurationNode t_node)
virtual

Initializes the sensor from the XML configuration tree.

The default implementation of this method does nothing.

Parameters
t_nodeThe XML configuration tree relative to this sensor.
See also
Reset()
Destroy()

Reimplemented from argos::CCI_Sensor.

Definition at line 47 of file battery_default_sensor.cpp.

void argos::CBatteryDefaultSensor::Reset ( )
virtual

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

The default implementation of this method does nothing.

See also
Init()
Destroy()

Reimplemented from argos::CCI_Sensor.

Definition at line 95 of file battery_default_sensor.cpp.

void argos::CBatteryDefaultSensor::SetRobot ( CComposableEntity c_entity)
virtual

Sets the entity associated to this sensor.

When a controller is created, all the sensors and actuators are created, too. This function is called right before the Init() method of the sensor is called.

Parameters
c_entityThe entity to associate to this sensor.
See also
CComposableEntity
CControllableEntity::SetController()
CCI_Sensor::Init()

Implements argos::CSimulatedSensor.

Definition at line 33 of file battery_default_sensor.cpp.

void argos::CBatteryDefaultSensor::Update ( )
virtual

Updates the state of the entity associated to this sensor.

Implements argos::CSimulatedSensor.

Definition at line 66 of file battery_default_sensor.cpp.

Member Data Documentation

bool argos::CBatteryDefaultSensor::m_bAddNoise
protected

Whether to add noise or not.

Definition at line 56 of file battery_default_sensor.h.

CRange<Real> argos::CBatteryDefaultSensor::m_cNoiseRange
protected

Noise range on battery level.

Definition at line 59 of file battery_default_sensor.h.

CBatteryEquippedEntity* argos::CBatteryDefaultSensor::m_pcBatteryEntity
protected

Reference to battery sensor equipped entity associated to this sensor.

Definition at line 50 of file battery_default_sensor.h.

CEmbodiedEntity* argos::CBatteryDefaultSensor::m_pcEmbodiedEntity
protected

Reference to embodied entity associated to this sensor.

Definition at line 47 of file battery_default_sensor.h.

CRandom::CRNG* argos::CBatteryDefaultSensor::m_pcRNG
protected

Random number generator.

Definition at line 53 of file battery_default_sensor.h.