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

#include <positional_entity.h>

+ Inheritance diagram for argos::CPositionalEntity:

List of all members.

Public Member Functions

 ENABLE_VTABLE ()
 CPositionalEntity (CComposableEntity *pc_parent)
 CPositionalEntity (CComposableEntity *pc_parent, const std::string &str_id, const CVector3 &c_position, const CQuaternion &c_orientation)
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.
const CVector3GetPosition () const
const CVector3GetInitPosition () const
void SetPosition (const CVector3 &c_position)
void SetInitPosition (const CVector3 &c_position)
const CQuaternionGetOrientation () const
const CQuaternionGetInitOrientation () const
void SetOrientation (const CQuaternion c_orientation)
void SetInitOrientation (const CQuaternion c_orientation)
virtual bool MoveTo (const CVector3 &c_position, const CQuaternion &c_orientation, bool b_check_only=false)
virtual std::string GetTypeDescription () const
 Returns a string label for this class.

Detailed Description

Definition at line 20 of file positional_entity.h.


Constructor & Destructor Documentation

argos::CPositionalEntity::CPositionalEntity ( CComposableEntity pc_parent,
const std::string &  str_id,
const CVector3 c_position,
const CQuaternion c_orientation 
)

Definition at line 24 of file positional_entity.cpp.


Member Function Documentation

Definition at line 56 of file positional_entity.h.

Definition at line 40 of file positional_entity.h.

Definition at line 52 of file positional_entity.h.

Definition at line 36 of file positional_entity.h.

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

Returns a string label for this class.

Returns:
A string label for this class.

Reimplemented from argos::CEntity.

Reimplemented in argos::CEmbodiedEntity, argos::CLEDEntity, argos::CRABEquippedEntity, and argos::CLightEntity.

Definition at line 72 of file positional_entity.h.

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

Reimplemented in argos::CEmbodiedEntity, argos::CLEDEntity, argos::CRABEquippedEntity, and argos::CLightEntity.

Definition at line 37 of file positional_entity.cpp.

bool argos::CPositionalEntity::MoveTo ( const CVector3 c_position,
const CQuaternion c_orientation,
bool  b_check_only = false 
) [virtual]

Reimplemented in argos::CEmbodiedEntity.

Definition at line 65 of file positional_entity.cpp.

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

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

Reimplemented in argos::CRABEquippedEntity, and argos::CLEDEntity.

Definition at line 56 of file positional_entity.cpp.

void argos::CPositionalEntity::SetInitOrientation ( const CQuaternion  c_orientation) [inline]

Definition at line 64 of file positional_entity.h.

void argos::CPositionalEntity::SetInitPosition ( const CVector3 c_position) [inline]

Definition at line 48 of file positional_entity.h.

void argos::CPositionalEntity::SetOrientation ( const CQuaternion  c_orientation) [inline]

Definition at line 60 of file positional_entity.h.

void argos::CPositionalEntity::SetPosition ( const CVector3 c_position) [inline]

Definition at line 44 of file positional_entity.h.


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