argos::CQuadRotorEntity Class Reference

#include <quadrotor_entity.h>

Inheritance diagram for argos::CQuadRotorEntity:

Collaboration diagram for argos::CQuadRotorEntity:

Classes
struct	SPositionControlData
struct	SSpeedControlData

Public Types
enum	EControlMethod { NO_CONTROL = 0, POSITION_CONTROL, SPEED_CONTROL }
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...

Public Member Functions
	ENABLE_VTABLE ()
	CQuadRotorEntity (CComposableEntity *pc_parent)
	CQuadRotorEntity (CComposableEntity *pc_parent, const std::string &str_id)
virtual	~CQuadRotorEntity ()
virtual void	Reset ()
	Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. More...
EControlMethod	GetControlMethod () const
void	SetControlMethod (EControlMethod e_control_method)
const SPositionControlData &	GetPositionControlData () const
void	SetPositionControlData (const SPositionControlData &s_data)
const SSpeedControlData &	GetSpeedControlData () const
void	SetSpeedControlData (const SSpeedControlData &s_data)
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...
CEntity &	GetRootEntity ()
	Returns the root entity containing this entity. More...
const CEntity &	GetRootEntity () const
	Returns the root entity containing this entity. More...
CComposableEntity &	GetParent ()
	Returns this entity's parent. More...
const CComposableEntity &	GetParent () 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...
TConfigurationNode *	GetConfigurationNode ()
	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

Detailed Description

Definition at line 15 of file quadrotor_entity.h.

Member Enumeration Documentation

EControlMethod

enum argos::CQuadRotorEntity::EControlMethod

Enumerator
NO_CONTROL
POSITION_CONTROL
SPEED_CONTROL

Definition at line 23 of file quadrotor_entity.h.

Constructor & Destructor Documentation

CQuadRotorEntity() [1/2]

argos::CQuadRotorEntity::CQuadRotorEntity

(

CComposableEntity *

pc_parent

)

Definition at line 33 of file quadrotor_entity.cpp.

CQuadRotorEntity() [2/2]

argos::CQuadRotorEntity::CQuadRotorEntity	(	CComposableEntity *	pc_parent,
		const std::string &	str_id
	)

Definition at line 42 of file quadrotor_entity.cpp.

~CQuadRotorEntity()

virtual argos::CQuadRotorEntity::~CQuadRotorEntity ( )

inlinevirtual

Definition at line 54 of file quadrotor_entity.h.

Member Function Documentation

ENABLE_VTABLE()

argos::CQuadRotorEntity::ENABLE_VTABLE

(

)

GetControlMethod()

EControlMethod argos::CQuadRotorEntity::GetControlMethod ( ) const

inline

Definition at line 58 of file quadrotor_entity.h.

GetPositionControlData()

const SPositionControlData& argos::CQuadRotorEntity::GetPositionControlData ( ) const

inline

Definition at line 66 of file quadrotor_entity.h.

GetSpeedControlData()

const SSpeedControlData& argos::CQuadRotorEntity::GetSpeedControlData ( ) const

inline

Definition at line 74 of file quadrotor_entity.h.

GetTypeDescription()

virtual std::string argos::CQuadRotorEntity::GetTypeDescription ( ) const

inlinevirtual

Returns a string label for this class.

Returns

A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 82 of file quadrotor_entity.h.

Reset()

void argos::CQuadRotorEntity::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 52 of file quadrotor_entity.cpp.

SetControlMethod()

void argos::CQuadRotorEntity::SetControlMethod ( EControlMethod  e_control_method )

inline

Definition at line 62 of file quadrotor_entity.h.

SetPositionControlData()

void argos::CQuadRotorEntity::SetPositionControlData ( const SPositionControlData &  s_data )

inline

Definition at line 70 of file quadrotor_entity.h.

SetSpeedControlData()

void argos::CQuadRotorEntity::SetSpeedControlData ( const SSpeedControlData &  s_data )

inline

Definition at line 78 of file quadrotor_entity.h.