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

#include <box_entity.h>

+ Inheritance diagram for argos::CBoxEntity:

List of all members.

Public Member Functions

 ENABLE_VTABLE ()
 CBoxEntity ()
 CBoxEntity (const std::string &str_id, const CVector3 &c_position, const CQuaternion &c_orientation, bool b_movable, const CVector3 &c_size, Real f_mass=1.0f)
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.
CEmbodiedEntityGetEmbodiedEntity ()
const CEmbodiedEntityGetEmbodiedEntity () const
CLEDEquippedEntityGetLEDEquippedEntity ()
const CLEDEquippedEntityGetLEDEquippedEntity () const
const CVector3GetSize () const
void SetSize (const CVector3 &c_size)
Real GetMass () const
void SetMass (Real f_mass)
virtual std::string GetTypeDescription () const
 Returns a string label for this class.

Detailed Description

Definition at line 20 of file box_entity.h.


Constructor & Destructor Documentation

Definition at line 18 of file box_entity.cpp.

argos::CBoxEntity::CBoxEntity ( const std::string &  str_id,
const CVector3 c_position,
const CQuaternion c_orientation,
bool  b_movable,
const CVector3 c_size,
Real  f_mass = 1.0f 
)

Definition at line 28 of file box_entity.cpp.


Member Function Documentation

Definition at line 38 of file box_entity.h.

Definition at line 42 of file box_entity.h.

Definition at line 50 of file box_entity.h.

Real argos::CBoxEntity::GetMass ( ) const [inline]

Definition at line 62 of file box_entity.h.

const CVector3& argos::CBoxEntity::GetSize ( ) const [inline]

Definition at line 54 of file box_entity.h.

virtual std::string argos::CBoxEntity::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 70 of file box_entity.h.

void argos::CBoxEntity::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 54 of file box_entity.cpp.

void argos::CBoxEntity::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 105 of file box_entity.cpp.

void argos::CBoxEntity::SetMass ( Real  f_mass) [inline]

Definition at line 66 of file box_entity.h.

void argos::CBoxEntity::SetSize ( const CVector3 c_size) [inline]

Definition at line 58 of file box_entity.h.


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