ARGoS  3
A parallel, multi-engine simulator for swarm robotics
argos::CGroundSensorEquippedEntity Class Reference

#include <ground_sensor_equipped_entity.h>

+ Inheritance diagram for argos::CGroundSensorEquippedEntity:

List of all members.

Classes

struct  SSensor

Public Types

enum  ESensorType { TYPE_BLACK_WHITE = 0, TYPE_GRAYSCALE }
typedef std::vector< SSensor * > TSensors

Public Member Functions

 ENABLE_VTABLE ()
 CGroundSensorEquippedEntity (CComposableEntity *pc_parent)
 CGroundSensorEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id)
virtual ~CGroundSensorEquippedEntity ()
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree.
virtual std::string GetTypeDescription () const
 Returns a string label for this class.
size_t GetNumSensors () const
SSensorGetSensor (size_t un_idx)
TSensorsGetSensors ()
void AddSensor (const CVector2 &c_offset, ESensorType e_type)
void AddSensorRing (const CVector2 &c_center, Real f_radius, const CRadians &c_start_angle, ESensorType e_type, UInt32 un_num_sensors)

Protected Member Functions

ESensorType ParseType (const std::string &str_type) const

Protected Attributes

TSensors m_tSensors
 The list of sensors.

Detailed Description

Definition at line 20 of file ground_sensor_equipped_entity.h.


Member Typedef Documentation


Member Enumeration Documentation

Enumerator:
TYPE_BLACK_WHITE 
TYPE_GRAYSCALE 

Definition at line 26 of file ground_sensor_equipped_entity.h.


Constructor & Destructor Documentation

Definition at line 23 of file ground_sensor_equipped_entity.cpp.


Member Function Documentation

void argos::CGroundSensorEquippedEntity::AddSensor ( const CVector2 c_offset,
ESensorType  e_type 
)

Definition at line 97 of file ground_sensor_equipped_entity.cpp.

void argos::CGroundSensorEquippedEntity::AddSensorRing ( const CVector2 c_center,
Real  f_radius,
const CRadians c_start_angle,
ESensorType  e_type,
UInt32  un_num_sensors 
)

Definition at line 105 of file ground_sensor_equipped_entity.cpp.

Definition at line 57 of file ground_sensor_equipped_entity.h.

Definition at line 61 of file ground_sensor_equipped_entity.h.

virtual std::string argos::CGroundSensorEquippedEntity::GetTypeDescription ( ) const [inline, virtual]

Returns a string label for this class.

Returns:
A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 53 of file ground_sensor_equipped_entity.h.

Initializes the state of the entity from the XML configuration tree.

If the id of the entity has not been set yet, this method sets an id for the entity. If the entity has no parent, this method parses the passed XML tree and looks for the id attribute, setting its value as id. If, instead, this entity has a parent, the id is set as GetParent().GetId() + "." + GetTypeDescription().

Exceptions:
CARGoSExceptionif a parse error occurred

Reimplemented from argos::CEntity.

Definition at line 42 of file ground_sensor_equipped_entity.cpp.

Definition at line 126 of file ground_sensor_equipped_entity.cpp.


Member Data Documentation

The list of sensors.

Definition at line 85 of file ground_sensor_equipped_entity.h.


The documentation for this class was generated from the following files: