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

#include <rab_equipped_entity.h>

+ Inheritance diagram for argos::CRABEquippedEntity:

List of all members.

Public Types

typedef std::vector
< CRABEquippedEntity * > 
TVector
 A vector of entities.
typedef CSet
< CRABEquippedEntity * > 
TSet

Public Member Functions

 ENABLE_VTABLE ()
 CRABEquippedEntity (CComposableEntity *pc_parent)
 CRABEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id, size_t un_msg_size, Real f_range, CEmbodiedEntity &c_reference, const CVector3 &c_position=CVector3(), const CQuaternion &c_orientation=CQuaternion())
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree.
virtual ~CRABEquippedEntity ()
virtual void Reset ()
 Resets the state of the entity to whatever it was after Init() or the standalone constructor was called.
virtual void Update ()
 Updates the state of this entity.
size_t GetMsgSize () const
CByteArrayGetData ()
void SetData (const CByteArray &c_data)
void ClearData ()
Real GetRange () const
CEmbodiedEntityGetReference ()
virtual std::string GetTypeDescription () const
 Returns a string label for this class.

Protected Attributes

CEmbodiedEntitym_pcReference
CVector3 m_cPosOffset
CQuaternion m_cRotOffset
CByteArray m_cData
Real m_fRange

Detailed Description

Definition at line 23 of file rab_equipped_entity.h.


Member Typedef Documentation

A vector of entities.

Reimplemented from argos::CEntity.

Definition at line 29 of file rab_equipped_entity.h.


Constructor & Destructor Documentation

argos::CRABEquippedEntity::CRABEquippedEntity ( CComposableEntity pc_parent,
const std::string &  str_id,
size_t  un_msg_size,
Real  f_range,
CEmbodiedEntity c_reference,
const CVector3 c_position = CVector3(),
const CQuaternion c_orientation = CQuaternion() 
)

Definition at line 28 of file rab_equipped_entity.cpp.

virtual argos::CRABEquippedEntity::~CRABEquippedEntity ( ) [inline, virtual]

Definition at line 46 of file rab_equipped_entity.h.


Member Function Documentation

Definition at line 56 of file rab_equipped_entity.h.

size_t argos::CRABEquippedEntity::GetMsgSize ( ) const [inline]

Definition at line 52 of file rab_equipped_entity.h.

Definition at line 64 of file rab_equipped_entity.h.

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

Returns a string label for this class.

Returns:
A string label for this class.

Reimplemented from argos::CPositionalEntity.

Definition at line 72 of file rab_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::CPositionalEntity.

Definition at line 51 of file rab_equipped_entity.cpp.

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

The default implementation of this method does nothing.

Reimplemented from argos::CPositionalEntity.

Definition at line 106 of file rab_equipped_entity.cpp.

Definition at line 113 of file rab_equipped_entity.cpp.

Updates the state of this entity.

The default implementation of this method does nothing.

Reimplemented from argos::CEntity.

Definition at line 98 of file rab_equipped_entity.cpp.


Member Data Documentation

Definition at line 81 of file rab_equipped_entity.h.

Definition at line 82 of file rab_equipped_entity.h.


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