argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor Class Reference

#include <colored_blob_omnidirectional_camera_rotzonly_sensor.h>

Inheritance diagram for argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor:
Collaboration diagram for argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor:

Public Member Functions

 CColoredBlobOmnidirectionalCameraRotZOnlySensor ()
 
virtual ~CColoredBlobOmnidirectionalCameraRotZOnlySensor ()
 
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...
 
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 IsShowRays ()
 Returns true if the rays must be shown in the GUI. More...
 
void SetShowRays (bool b_show_rays)
 Sets whether or not the rays must be shown in the GUI. More...
 
- Public Member Functions inherited from argos::CCI_ColoredBlobOmnidirectionalCameraSensor
 CCI_ColoredBlobOmnidirectionalCameraSensor ()
 Constructor. More...
 
virtual ~CCI_ColoredBlobOmnidirectionalCameraSensor ()
 Destructor. More...
 
const SReadingsGetReadings () const
 Returns a reference to the current camera readings. More...
 
- Public Member Functions inherited from argos::CCI_Sensor
virtual ~CCI_Sensor ()
 Class destructor. More...
 
bool IsEnabled () const
 
bool IsDisabled () const
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::CSimulatedSensor
virtual ~CSimulatedSensor ()
 Class destructor. More...
 

Protected Attributes

COmnidirectionalCameraEquippedEntitym_pcOmnicamEntity
 
CControllableEntitym_pcControllableEntity
 
CEmbodiedEntitym_pcEmbodiedEntity
 
CPositionalIndex< CLEDEntity > * m_pcLEDIndex
 
CPositionalIndex< CEmbodiedEntity > * m_pcEmbodiedIndex
 
COmnidirectionalCameraLEDCheckOperationm_pcOperation
 
bool m_bShowRays
 
- Protected Attributes inherited from argos::CCI_ColoredBlobOmnidirectionalCameraSensor
SReadings m_sReadings
 

Additional Inherited Members

- Public Types inherited from argos::CCI_ColoredBlobOmnidirectionalCameraSensor
typedef std::vector< SBlob * > TBlobList
 Vector of pointers to colored blobs. More...
 
- Public Types inherited from argos::CCI_Sensor
typedef std::map< std::string, CCI_Sensor *, std::less< std::string > > TMap
 

Detailed Description

Constructor & Destructor Documentation

◆ CColoredBlobOmnidirectionalCameraRotZOnlySensor()

argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::CColoredBlobOmnidirectionalCameraRotZOnlySensor ( )

◆ ~CColoredBlobOmnidirectionalCameraRotZOnlySensor()

argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::~CColoredBlobOmnidirectionalCameraRotZOnlySensor ( )
virtual

Member Function Documentation

◆ Destroy()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::Destroy ( )
virtual

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

Reimplemented from argos::CCI_Sensor.

Definition at line 218 of file colored_blob_omnidirectional_camera_rotzonly_sensor.cpp.

◆ Disable()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::Disable ( )
virtual

Disables updating of sensor information in the event loop.

Reimplemented from argos::CCI_Sensor.

Definition at line 233 of file colored_blob_omnidirectional_camera_rotzonly_sensor.cpp.

◆ Enable()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::Enable ( )
virtual

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 from argos::CCI_Sensor.

Definition at line 225 of file colored_blob_omnidirectional_camera_rotzonly_sensor.cpp.

◆ Init()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::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 152 of file colored_blob_omnidirectional_camera_rotzonly_sensor.cpp.

◆ IsShowRays()

bool argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::IsShowRays ( )
inline

Returns true if the rays must be shown in the GUI.

Returns
true if the rays must be shown in the GUI.

Definition at line 46 of file colored_blob_omnidirectional_camera_rotzonly_sensor.h.

◆ Reset()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::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 210 of file colored_blob_omnidirectional_camera_rotzonly_sensor.cpp.

◆ SetRobot()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::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 140 of file colored_blob_omnidirectional_camera_rotzonly_sensor.cpp.

◆ SetShowRays()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::SetShowRays ( bool  b_show_rays)
inline

Sets whether or not the rays must be shown in the GUI.

Parameters
b_show_raystrue if the rays must be shown, false otherwise

Definition at line 54 of file colored_blob_omnidirectional_camera_rotzonly_sensor.h.

◆ Update()

void argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::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 184 of file colored_blob_omnidirectional_camera_rotzonly_sensor.cpp.

Member Data Documentation

◆ m_bShowRays

bool argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::m_bShowRays
protected

◆ m_pcControllableEntity

CControllableEntity* argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::m_pcControllableEntity
protected

◆ m_pcEmbodiedEntity

CEmbodiedEntity* argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::m_pcEmbodiedEntity
protected

◆ m_pcEmbodiedIndex

CPositionalIndex<CEmbodiedEntity>* argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::m_pcEmbodiedIndex
protected

◆ m_pcLEDIndex

CPositionalIndex<CLEDEntity>* argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::m_pcLEDIndex
protected

◆ m_pcOmnicamEntity

COmnidirectionalCameraEquippedEntity* argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::m_pcOmnicamEntity
protected

◆ m_pcOperation

COmnidirectionalCameraLEDCheckOperation* argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor::m_pcOperation
protected