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

#include <light_entity.h>

+ Inheritance diagram for argos::CLightEntity:

List of all members.

Public Member Functions

 ENABLE_VTABLE ()
 CLightEntity ()
 CLightEntity (const std::string &str_id, const CVector3 &c_position, const CColor &c_color, Real f_intensity)
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree.
Real GetIntensity () const
void SetIntensity (Real f_intensity)
virtual std::string GetTypeDescription () const
 Returns a string label for this class.

Protected Attributes

Real m_fIntensity

Detailed Description

Definition at line 20 of file light_entity.h.


Constructor & Destructor Documentation

Definition at line 17 of file light_entity.cpp.

argos::CLightEntity::CLightEntity ( const std::string &  str_id,
const CVector3 c_position,
const CColor c_color,
Real  f_intensity 
)

Definition at line 24 of file light_entity.cpp.


Member Function Documentation

Definition at line 37 of file light_entity.h.

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

Returns a string label for this class.

Returns:
A string label for this class.

Reimplemented from argos::CLEDEntity.

Definition at line 45 of file light_entity.h.

void argos::CLightEntity::Init ( TConfigurationNode t_tree) [virtual]

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::CLEDEntity.

Definition at line 37 of file light_entity.cpp.

void argos::CLightEntity::SetIntensity ( Real  f_intensity) [inline]

Definition at line 41 of file light_entity.h.


Member Data Documentation

Definition at line 51 of file light_entity.h.


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