argos::CWheeledEntity Class Reference

#include <wheeled_entity.h>

Inheritance diagram for argos::CWheeledEntity:
Collaboration diagram for argos::CWheeledEntity:

Public Member Functions

 ENABLE_VTABLE ()
 
 CWheeledEntity (CComposableEntity *pc_parent, size_t un_num_wheels)
 
 CWheeledEntity (CComposableEntity *pc_parent, const std::string &str_id, size_t un_num_wheels)
 
virtual ~CWheeledEntity ()
 
virtual void Reset ()
 Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. More...
 
size_t GetNumWheels () const
 
void SetWheel (UInt32 un_index, const CVector3 &c_position, Real f_radius)
 
const CVector3GetWheelPosition (size_t un_index) const
 
const CVector3GetWheelPositions () const
 
Real GetWheelRadius (size_t un_index) const
 
const RealGetWheelRadia () const
 
Real GetWheelVelocity (size_t un_index) const
 
const RealGetWheelVelocities () const
 
void SetVelocities (Real *pf_velocities)
 
virtual std::string GetTypeDescription () const
 Returns a string label for this class. More...
 
- Public Member Functions inherited from argos::CEntity
 ENABLE_VTABLE ()
 
 CEntity (CComposableEntity *pc_parent)
 Class constructor. More...
 
 CEntity (CComposableEntity *pc_parent, const std::string &str_id)
 Class constructor. More...
 
virtual ~CEntity ()
 Class destructor. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
virtual void Destroy ()
 Destroys the entity, undoing whatever was done by Init() or by the standalone constructor. More...
 
const std::string & GetId () const
 Returns the id of this entity. More...
 
std::string GetContext () const
 Returns the context of this entity. More...
 
bool HasParent () const
 Returns true if this entity has a parent. More...
 
CEntityGetRootEntity ()
 Returns the root entity containing this entity. More...
 
const CEntityGetRootEntity () const
 Returns the root entity containing this entity. More...
 
CComposableEntityGetParent ()
 Returns this entity's parent. More...
 
const CComposableEntityGetParent () const
 Returns this entity's parent. More...
 
void SetParent (CComposableEntity &c_parent)
 Sets this entity's parent. More...
 
virtual void Update ()
 Updates the state of this entity. More...
 
ssize_t GetIndex () const
 Returns the entity index. More...
 
void SetIndex (ssize_t n_idx)
 Sets the entity index. More...
 
bool IsEnabled () const
 Returns true if the entity is enabled. More...
 
void Enable ()
 Enables the entity. More...
 
void Disable ()
 Disables the entity. More...
 
virtual void SetEnabled (bool b_enabled)
 Enables or disables an entity. More...
 
TConfigurationNodeGetConfigurationNode ()
 Returns a pointer to the configuration node that was used to create this entity. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 
- Public Member Functions inherited from argos::EnableVTableFor< CEntity >
size_t GetTagHelper (const DERIVED *) const
 

Additional Inherited Members

- Public Types inherited from argos::CEntity
typedef std::vector< CEntity * > TVector
 A vector of entities. More...
 
typedef unordered_map< std::string, CEntity * > TMap
 A map of entities. More...
 
typedef std::multimap< std::string, CEntity * > TMultiMap
 A multi-map of entities. More...
 

Detailed Description

Definition at line 15 of file wheeled_entity.h.

Constructor & Destructor Documentation

argos::CWheeledEntity::CWheeledEntity ( CComposableEntity pc_parent,
size_t  un_num_wheels 
)

Definition at line 15 of file wheeled_entity.cpp.

argos::CWheeledEntity::CWheeledEntity ( CComposableEntity pc_parent,
const std::string &  str_id,
size_t  un_num_wheels 
)

Definition at line 31 of file wheeled_entity.cpp.

argos::CWheeledEntity::~CWheeledEntity ( )
virtual

Definition at line 48 of file wheeled_entity.cpp.

Member Function Documentation

argos::CWheeledEntity::ENABLE_VTABLE ( )
size_t argos::CWheeledEntity::GetNumWheels ( ) const
inline

Definition at line 34 of file wheeled_entity.h.

virtual std::string argos::CWheeledEntity::GetTypeDescription ( ) const
inlinevirtual

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 62 of file wheeled_entity.h.

const CVector3 & argos::CWheeledEntity::GetWheelPosition ( size_t  un_index) const

Definition at line 79 of file wheeled_entity.cpp.

const CVector3* argos::CWheeledEntity::GetWheelPositions ( ) const
inline

Definition at line 44 of file wheeled_entity.h.

const Real* argos::CWheeledEntity::GetWheelRadia ( ) const
inline

Definition at line 50 of file wheeled_entity.h.

Real argos::CWheeledEntity::GetWheelRadius ( size_t  un_index) const

Definition at line 91 of file wheeled_entity.cpp.

const Real* argos::CWheeledEntity::GetWheelVelocities ( ) const
inline

Definition at line 56 of file wheeled_entity.h.

Real argos::CWheeledEntity::GetWheelVelocity ( size_t  un_index) const

Definition at line 103 of file wheeled_entity.cpp.

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

Definition at line 57 of file wheeled_entity.cpp.

void argos::CWheeledEntity::SetVelocities ( Real pf_velocities)

Definition at line 115 of file wheeled_entity.cpp.

void argos::CWheeledEntity::SetWheel ( UInt32  un_index,
const CVector3 c_position,
Real  f_radius 
)

Definition at line 64 of file wheeled_entity.cpp.