argos::CFootBotTurretEntity Class Reference

#include <footbot_turret_entity.h>

Inheritance diagram for argos::CFootBotTurretEntity:

Collaboration diagram for argos::CFootBotTurretEntity:

Public Types
enum	EMode { MODE_OFF, MODE_PASSIVE, MODE_SPEED_CONTROL, MODE_POSITION_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 ()
	CFootBotTurretEntity (CComposableEntity *pc_parent)
	CFootBotTurretEntity (CComposableEntity *pc_parent, const std::string &str_id, SAnchor &s_anchor)
virtual void	Init (TConfigurationNode &t_tree)
	Initializes the state of the entity from the XML configuration tree. More...
virtual void	Reset ()
	Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. More...
virtual void	Update ()
	Updates the state of this entity. More...
UInt32	GetMode () const
void	SetMode (UInt32 un_mode)
CRadians	GetRotation () const
Real	GetRotationSpeed () const
const CRadians &	GetDesiredRotation () const
Real	GetDesiredRotationSpeed () const
void	SetDesiredRotation (const CRadians &c_rotation)
void	SetDesiredRotationSpeed (Real f_speed)
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	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...
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 20 of file footbot_turret_entity.h.

Member Enumeration Documentation

EMode

enum argos::CFootBotTurretEntity::EMode

Enumerator
MODE_OFF
MODE_PASSIVE
MODE_SPEED_CONTROL
MODE_POSITION_CONTROL

Definition at line 26 of file footbot_turret_entity.h.

Constructor & Destructor Documentation

CFootBotTurretEntity() [1/2]

argos::CFootBotTurretEntity::CFootBotTurretEntity

(

CComposableEntity *

pc_parent

)

Definition at line 17 of file footbot_turret_entity.cpp.

CFootBotTurretEntity() [2/2]

argos::CFootBotTurretEntity::CFootBotTurretEntity	(	CComposableEntity *	pc_parent,
		const std::string &	str_id,
		SAnchor &	s_anchor
	)

Definition at line 27 of file footbot_turret_entity.cpp.

Member Function Documentation

ENABLE_VTABLE()

argos::CFootBotTurretEntity::ENABLE_VTABLE

(

)

GetDesiredRotation()

const CRadians & argos::CFootBotTurretEntity::GetDesiredRotation

(

)

const

Definition at line 89 of file footbot_turret_entity.cpp.

GetDesiredRotationSpeed()

Real argos::CFootBotTurretEntity::GetDesiredRotationSpeed

(

)

const

Definition at line 96 of file footbot_turret_entity.cpp.

GetMode()

UInt32 argos::CFootBotTurretEntity::GetMode ( ) const

inline

Definition at line 47 of file footbot_turret_entity.h.

GetRotation()

CRadians argos::CFootBotTurretEntity::GetRotation

(

)

const

Definition at line 73 of file footbot_turret_entity.cpp.

GetRotationSpeed()

Real argos::CFootBotTurretEntity::GetRotationSpeed

(

)

const

Definition at line 82 of file footbot_turret_entity.cpp.

GetTypeDescription()

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

inlinevirtual

Returns a string label for this class.

Returns

A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 67 of file footbot_turret_entity.h.

Init()

void argos::CFootBotTurretEntity::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

CARGoSException

if a parse error occurred

Reimplemented from argos::CEntity.

Definition at line 39 of file footbot_turret_entity.cpp.

Reset()

void argos::CFootBotTurretEntity::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 45 of file footbot_turret_entity.cpp.

SetDesiredRotation()

void argos::CFootBotTurretEntity::SetDesiredRotation

(

const CRadians &

c_rotation

)

Definition at line 103 of file footbot_turret_entity.cpp.

SetDesiredRotationSpeed()

void argos::CFootBotTurretEntity::SetDesiredRotationSpeed

(

Real

f_speed

)

Definition at line 111 of file footbot_turret_entity.cpp.

SetMode()

void argos::CFootBotTurretEntity::SetMode ( UInt32  un_mode )

inline

Definition at line 51 of file footbot_turret_entity.h.

Update()

void argos::CFootBotTurretEntity::Update ( )

virtual

Updates the state of this entity.

The default implementation of this method does nothing.

Reimplemented from argos::CEntity.

Definition at line 59 of file footbot_turret_entity.cpp.