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

#include <epuck_entity.h>

+ Inheritance diagram for argos::CEPuckEntity:

List of all members.

Public Member Functions

 ENABLE_VTABLE ()
 CEPuckEntity ()
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree.
virtual void Reset ()
 Resets the state of the entity to whatever it was after Init() or the standalone constructor was called.
virtual void Destroy ()
 Destroys the entity, undoing whatever was done by Init() or by the standalone constructor.
virtual void UpdateComponents ()
 Calls the Update() method on all the components.
CControllableEntityGetControllableEntity ()
CEmbodiedEntityGetEmbodiedEntity ()
CGroundSensorEquippedEntityGetGroundSensorEquippedEntity ()
CLEDEquippedEntityGetLEDEquippedEntity ()
CLightSensorEquippedEntityGetLightSensorEquippedEntity ()
CProximitySensorEquippedEntityGetProximitySensorEquippedEntity ()
CRABEquippedEntityGetRABEquippedEntity ()
CWheeledEntityGetWheeledEntity ()
virtual std::string GetTypeDescription () const
 Returns a string label for this class.

Detailed Description

Definition at line 26 of file epuck_entity.h.


Constructor & Destructor Documentation

Definition at line 44 of file epuck_entity.cpp.


Member Function Documentation

void argos::CEPuckEntity::Destroy ( ) [virtual]

Destroys the entity, undoing whatever was done by Init() or by the standalone constructor.

The default implementation of this method does nothing.

Reimplemented from argos::CEntity.

Definition at line 156 of file epuck_entity.cpp.

Definition at line 46 of file epuck_entity.h.

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

Returns a string label for this class.

Returns:
A string label for this class.

Reimplemented from argos::CComposableEntity.

Definition at line 74 of file epuck_entity.h.

Definition at line 70 of file epuck_entity.h.

void argos::CEPuckEntity::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::CEntity.

Definition at line 59 of file epuck_entity.cpp.

void argos::CEPuckEntity::Reset ( ) [virtual]

Resets the state of the entity to whatever it was after Init() or the standalone constructor was called.

Internally calls Reset() for all the component entities.

Reimplemented from argos::CComposableEntity.

Definition at line 146 of file epuck_entity.cpp.

Calls the Update() method on all the components.

See also:
Update()

Reimplemented from argos::CComposableEntity.

Definition at line 165 of file epuck_entity.cpp.


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