#include <rab_equipped_entity.h>

Inheritance diagram for argos::CRABEquippedEntity:

[legend]

Collaboration diagram for argos::CRABEquippedEntity:

[legend]

Public Types
typedef std::vector< CRABEquippedEntity * >	TVector

typedef CSet< CRABEquippedEntity * >	TSet

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 ()

	CRABEquippedEntity (CComposableEntity *pc_parent)

	CRABEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id, size_t un_msg_size, Real f_range, SAnchor &s_anchor, CEmbodiedEntity &c_entity_body, const CVector3 &c_position=CVector3(), const CQuaternion &c_orientation=CQuaternion())

virtual void	Init (TConfigurationNode &t_tree)
	Initializes the state of the entity from the XML configuration tree. More...

virtual	~CRABEquippedEntity ()

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

virtual void	SetEnabled (bool b_enabled)
	Enables or disables an entity. More...

CEmbodiedEntity &	GetEntityBody ()

size_t	GetMsgSize () const

CByteArray &	GetData ()

void	SetData (const CByteArray &c_data)

void	ClearData ()

Real	GetRange () const

void	SetRange (Real f_range)

const SAnchor &	GetAnchor () const

virtual std::string	GetTypeDescription () const
	Returns a string label for this class. More...

CRABMedium &	GetMedium ()

void	SetMedium (CRABMedium &c_medium)

Public Member Functions inherited from argos::CPositionalEntity
	ENABLE_VTABLE ()

	CPositionalEntity (CComposableEntity *pc_parent)

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

const CVector3 &	GetPosition () const

const CVector3 &	GetInitPosition () const

void	SetPosition (const CVector3 &c_position)

void	SetInitPosition (const CVector3 &c_position)

const CQuaternion &	GetOrientation () const

const CQuaternion &	GetInitOrientation () const

void	SetOrientation (const CQuaternion c_orientation)

void	SetInitOrientation (const CQuaternion c_orientation)

virtual void	MoveTo (const CVector3 &c_position, const CQuaternion &c_orientation)

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

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

Protected Attributes
SAnchor *	m_psAnchor

CVector3	m_cPosOffset

CQuaternion	m_cRotOffset

CByteArray	m_cData

Real	m_fRange

CEmbodiedEntity *	m_pcEntityBody

CRABMedium *	m_pcMedium

Detailed Description

Definition at line 26 of file rab_equipped_entity.h.

Member Typedef Documentation

◆ TSet

typedef CSet<CRABEquippedEntity*> argos::CRABEquippedEntity::TSet

Definition at line 33 of file rab_equipped_entity.h.

◆ TVector

typedef std::vector<CRABEquippedEntity*> argos::CRABEquippedEntity::TVector

Definition at line 32 of file rab_equipped_entity.h.

Constructor & Destructor Documentation

◆ CRABEquippedEntity() [1/2]

argos::CRABEquippedEntity::CRABEquippedEntity ( CComposableEntity * pc_parent )

Definition at line 20 of file rab_equipped_entity.cpp.

◆ CRABEquippedEntity() [2/2]

argos::CRABEquippedEntity::CRABEquippedEntity	(	CComposableEntity *	pc_parent,
		const std::string &	str_id,
		size_t	un_msg_size,
		Real	f_range,
		SAnchor &	s_anchor,
		CEmbodiedEntity &	c_entity_body,
		const CVector3 &	c_position = `CVector3()`,
		const CQuaternion &	c_orientation = `CQuaternion()`
	)

Definition at line 32 of file rab_equipped_entity.cpp.

◆ ~CRABEquippedEntity()

virtual argos::CRABEquippedEntity::~CRABEquippedEntity ( )

inlinevirtual

Definition at line 50 of file rab_equipped_entity.h.

Member Function Documentation

◆ ClearData()

void argos::CRABEquippedEntity::ClearData ( )

Definition at line 169 of file rab_equipped_entity.cpp.

◆ ENABLE_VTABLE()

argos::CRABEquippedEntity::ENABLE_VTABLE ( )

◆ GetAnchor()

const SAnchor& argos::CRABEquippedEntity::GetAnchor ( ) const

inline

Definition at line 82 of file rab_equipped_entity.h.

◆ GetData()

CByteArray& argos::CRABEquippedEntity::GetData ( )

inline

Definition at line 66 of file rab_equipped_entity.h.

◆ GetEntityBody()

CEmbodiedEntity& argos::CRABEquippedEntity::GetEntityBody ( )

inline

Definition at line 58 of file rab_equipped_entity.h.

◆ GetMedium()

CRABMedium& argos::CRABEquippedEntity::GetMedium ( )

inline

Definition at line 90 of file rab_equipped_entity.h.

◆ GetMsgSize()

size_t argos::CRABEquippedEntity::GetMsgSize ( ) const

inline

Definition at line 62 of file rab_equipped_entity.h.

◆ GetRange()

Real argos::CRABEquippedEntity::GetRange ( ) const

inline

Definition at line 74 of file rab_equipped_entity.h.

◆ GetTypeDescription()

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

inlinevirtual

Returns a string label for this class.

Returns: A string label for this class.

Reimplemented from argos::CPositionalEntity.

Definition at line 86 of file rab_equipped_entity.h.

◆ Init()

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

Definition at line 62 of file rab_equipped_entity.cpp.

◆ Reset()

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

Definition at line 125 of file rab_equipped_entity.cpp.

◆ SetData()

void argos::CRABEquippedEntity::SetData ( const CByteArray & c_data )

Definition at line 157 of file rab_equipped_entity.cpp.

◆ SetEnabled()

void argos::CRABEquippedEntity::SetEnabled ( bool b_enabled )

virtual

Enables or disables an entity.

Parameters

b_enabled true if the entity is enabled, false otherwise

See also: m_bEnabled; m_bCanBeEnabledIfDisabled

Reimplemented from argos::CEntity.

Definition at line 132 of file rab_equipped_entity.cpp.

◆ SetMedium()

void argos::CRABEquippedEntity::SetMedium ( CRABMedium & c_medium )

inline

Definition at line 94 of file rab_equipped_entity.h.

◆ SetRange()

void argos::CRABEquippedEntity::SetRange ( Real f_range )

inline

Definition at line 78 of file rab_equipped_entity.h.

◆ Update()

void argos::CRABEquippedEntity::Update ( )

virtual

Updates the state of this entity.

The default implementation of this method does nothing.

Reimplemented from argos::CEntity.

Definition at line 114 of file rab_equipped_entity.cpp.

Member Data Documentation

◆ m_cData

CByteArray argos::CRABEquippedEntity::m_cData

protected

Definition at line 103 of file rab_equipped_entity.h.

◆ m_cPosOffset

CVector3 argos::CRABEquippedEntity::m_cPosOffset

protected

Definition at line 101 of file rab_equipped_entity.h.

◆ m_cRotOffset

CQuaternion argos::CRABEquippedEntity::m_cRotOffset

protected

Definition at line 102 of file rab_equipped_entity.h.

◆ m_fRange

Real argos::CRABEquippedEntity::m_fRange

protected

Definition at line 104 of file rab_equipped_entity.h.

◆ m_pcEntityBody

CEmbodiedEntity* argos::CRABEquippedEntity::m_pcEntityBody

protected

Definition at line 105 of file rab_equipped_entity.h.

◆ m_pcMedium

CRABMedium* argos::CRABEquippedEntity::m_pcMedium

protected

Definition at line 106 of file rab_equipped_entity.h.

◆ m_psAnchor

SAnchor* argos::CRABEquippedEntity::m_psAnchor

protected

Definition at line 100 of file rab_equipped_entity.h.

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TSet

◆ TVector

Constructor & Destructor Documentation

◆ CRABEquippedEntity() [1/2]

◆ CRABEquippedEntity() [2/2]

◆ ~CRABEquippedEntity()

Member Function Documentation

◆ ClearData()

◆ ENABLE_VTABLE()

◆ GetAnchor()

◆ GetData()

◆ GetEntityBody()

◆ GetMedium()

◆ GetMsgSize()

◆ GetRange()

◆ GetTypeDescription()

◆ Init()

◆ Reset()

◆ SetData()

◆ SetEnabled()

◆ SetMedium()

◆ SetRange()

◆ Update()

Member Data Documentation

◆ m_cData

◆ m_cPosOffset

◆ m_cRotOffset

◆ m_fRange

◆ m_pcEntityBody

◆ m_pcMedium

◆ m_psAnchor