argos::CGroundRotZOnlySensor Class Reference

#include <ground_rotzonly_sensor.h>

Inheritance diagram for argos::CGroundRotZOnlySensor:

Collaboration diagram for argos::CGroundRotZOnlySensor:

Public Member Functions
	CGroundRotZOnlySensor ()
virtual	~CGroundRotZOnlySensor ()
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, if the sensor is currently enabled. 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_GroundSensor
virtual	~CCI_GroundSensor ()
const std::vector< Real > &	GetReadings () const
Public Member Functions inherited from argos::CCI_Sensor
virtual	~CCI_Sensor ()
	Class destructor. 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...

Protected Attributes
CEmbodiedEntity *	m_pcEmbodiedEntity
	Reference to embodied entity associated to this sensor. More...
CFloorEntity *	m_pcFloorEntity
	Reference to floor entity. More...
CGroundSensorEquippedEntity *	m_pcGroundSensorEntity
	Reference to ground sensor equipped entity associated to this sensor. More...
CRandom::CRNG *	m_pcRNG
	Random number generator. More...
bool	m_bAddNoise
	Whether to add noise or not. More...
CRange< Real >	m_cNoiseRange
	Noise range. More...
CSpace &	m_cSpace
	Reference to the space. More...
Protected Attributes inherited from argos::CCI_GroundSensor
std::vector< Real >	m_tReadings

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

Constructor & Destructor Documentation

CGroundRotZOnlySensor()

argos::CGroundRotZOnlySensor::CGroundRotZOnlySensor

(

)

Definition at line 25 of file ground_rotzonly_sensor.cpp.

~CGroundRotZOnlySensor()

virtual argos::CGroundRotZOnlySensor::~CGroundRotZOnlySensor ( )

inlinevirtual

Definition at line 34 of file ground_rotzonly_sensor.h.

Member Function Documentation

Init()

void argos::CGroundRotZOnlySensor::Init ( TConfigurationNode &  t_node )

virtual

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()

Reimplemented from argos::CCI_Sensor.

Definition at line 46 of file ground_rotzonly_sensor.cpp.

Reset()

void argos::CGroundRotZOnlySensor::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 120 of file ground_rotzonly_sensor.cpp.

SetRobot()

void argos::CGroundRotZOnlySensor::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_entity

The entity to associate to this sensor.

See also

CComposableEntity

CControllableEntity::SetController()

CCI_Sensor::Init()

Implements argos::CSimulatedSensor.

Definition at line 36 of file ground_rotzonly_sensor.cpp.

Update()

void argos::CGroundRotZOnlySensor::Update ( )

virtual

Updates the state of the entity associated to this sensor, if the sensor is currently enabled.

If it is disabled, then this function should do nothing.

Implements argos::CSimulatedSensor.

Definition at line 72 of file ground_rotzonly_sensor.cpp.

Member Data Documentation

m_bAddNoise

bool argos::CGroundRotZOnlySensor::m_bAddNoise

protected

Whether to add noise or not.

Definition at line 59 of file ground_rotzonly_sensor.h.

m_cNoiseRange

CRange<Real> argos::CGroundRotZOnlySensor::m_cNoiseRange

protected

Noise range.

Definition at line 62 of file ground_rotzonly_sensor.h.

m_cSpace

CSpace& argos::CGroundRotZOnlySensor::m_cSpace

protected

Reference to the space.

Definition at line 65 of file ground_rotzonly_sensor.h.

m_pcEmbodiedEntity

CEmbodiedEntity* argos::CGroundRotZOnlySensor::m_pcEmbodiedEntity

protected

Reference to embodied entity associated to this sensor.

Definition at line 47 of file ground_rotzonly_sensor.h.

m_pcFloorEntity

CFloorEntity* argos::CGroundRotZOnlySensor::m_pcFloorEntity

protected

Reference to floor entity.

Definition at line 50 of file ground_rotzonly_sensor.h.

m_pcGroundSensorEntity

CGroundSensorEquippedEntity* argos::CGroundRotZOnlySensor::m_pcGroundSensorEntity

protected

Reference to ground sensor equipped entity associated to this sensor.

Definition at line 53 of file ground_rotzonly_sensor.h.

m_pcRNG

CRandom::CRNG* argos::CGroundRotZOnlySensor::m_pcRNG

protected

Random number generator.

Definition at line 56 of file ground_rotzonly_sensor.h.