argos::CPrototypeJointsDefaultSensor Class Reference

#include <prototype_joints_default_sensor.h>

Inheritance diagram for argos::CPrototypeJointsDefaultSensor:
Collaboration diagram for argos::CPrototypeJointsDefaultSensor:

Classes

struct  SSimulatedSensor
 

Public Member Functions

 CPrototypeJointsDefaultSensor ()
 
virtual ~CPrototypeJointsDefaultSensor ()
 
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_PrototypeJointsSensor
virtual ~CCI_PrototypeJointsSensor ()
 Destructor. More...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 
- Protected Attributes inherited from argos::CCI_PrototypeJointsSensor
SSensor::TVector m_vecSensors
 

Detailed Description

Definition at line 21 of file prototype_joints_default_sensor.h.

Constructor & Destructor Documentation

◆ CPrototypeJointsDefaultSensor()

argos::CPrototypeJointsDefaultSensor::CPrototypeJointsDefaultSensor ( )

Definition at line 14 of file prototype_joints_default_sensor.cpp.

◆ ~CPrototypeJointsDefaultSensor()

virtual argos::CPrototypeJointsDefaultSensor::~CPrototypeJointsDefaultSensor ( )
inlinevirtual

Definition at line 36 of file prototype_joints_default_sensor.h.

Member Function Documentation

◆ Init()

void argos::CPrototypeJointsDefaultSensor::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 27 of file prototype_joints_default_sensor.cpp.

◆ Reset()

void argos::CPrototypeJointsDefaultSensor::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 81 of file prototype_joints_default_sensor.cpp.

◆ SetRobot()

void argos::CPrototypeJointsDefaultSensor::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 20 of file prototype_joints_default_sensor.cpp.

◆ Update()

void argos::CPrototypeJointsDefaultSensor::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 68 of file prototype_joints_default_sensor.cpp.