#include <magnet_equipped_entity.h>

Inheritance diagram for argos::CMagnetEquippedEntity:

[legend]

Collaboration diagram for argos::CMagnetEquippedEntity:

[legend]

Classes
struct	SInstance

Public Member Functions
	ENABLE_VTABLE ()

	CMagnetEquippedEntity (CComposableEntity *pc_parent)
	Class constructor. More...

	CMagnetEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id)
	Class constructor. More...

virtual	~CMagnetEquippedEntity ()

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

virtual void	Enable ()

virtual void	Disable ()

CMagnetEntity &	GetMagnet (UInt32 un_index)
	Returns an magnet by numeric index. More...

CMagnetEntity &	AddMagnet (const std::string &str_id, SAnchor &s_anchor, const CVector3 &c_position_offset, const CVector3 &c_passive_field, const CVector3 &c_active_field=CVector3())

SInstance::TVector &	GetInstances ()

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

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

	CComposableEntity (CComposableEntity *pc_parent)
	Class constructor. More...

	CComposableEntity (CComposableEntity *pc_parent, const std::string &str_id)
	Class constructor. More...

virtual	~CComposableEntity ()
	Class destructor. 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 status of this entity. More...

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

void	AddComponent (CEntity &c_component)
	Adds a component to this composable entity. More...

CEntity &	RemoveComponent (const std::string &str_component)
	Removes a component from this composable entity. More...

CEntity &	GetComponent (const std::string &str_component)
	Returns the component with the passed string label. More...

template<class E >
E &	GetComponent (const std::string &str_component)
	Returns the component with the passed string label. More...

bool	HasComponent (const std::string &str_component)
	Returns `true` if this composable entity has a component with the given string label. More...

CEntity::TMultiMap::iterator	FindComponent (const std::string &str_component)
	Searches for a component with the given string label. More...

CEntity::TMultiMap &	GetComponentMap ()
	Returns the map of all the components. More...

CEntity::TVector &	GetComponentVector ()
	Returns the vector of all the components. 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...

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 Member Functions
virtual void	UpdateComponents ()
	Calls the Update() method on all the components. More...

Protected Attributes
SInstance::TVector	m_vecInstances
	A list of the magnets managed by this entity. More...

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

A container of CMagnetEntity.

This is a convenience class that acts a container of CMagnetEntity objects. It is mostly useful when a robot is equipped with a number of magnets, and you want to manage them comfortably.

See also: CMagnetEntity

Definition at line 30 of file magnet_equipped_entity.h.

Constructor & Destructor Documentation

◆ CMagnetEquippedEntity() [1/2]

argos::CMagnetEquippedEntity::CMagnetEquippedEntity ( CComposableEntity * pc_parent )

Class constructor.

Parameters

pc_parent The parent entity.

Definition at line 24 of file magnet_equipped_entity.cpp.

◆ CMagnetEquippedEntity() [2/2]

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

Class constructor.

Parameters

pc_parent	The parent entity.
str_id	The id of this entity.

Definition at line 32 of file magnet_equipped_entity.cpp.

◆ ~CMagnetEquippedEntity()

virtual argos::CMagnetEquippedEntity::~CMagnetEquippedEntity ( )

inlinevirtual

Definition at line 64 of file magnet_equipped_entity.h.

Member Function Documentation

◆ AddMagnet()

CMagnetEntity & argos::CMagnetEquippedEntity::AddMagnet	(	const std::string &	str_id,
		SAnchor &	s_anchor,
		const CVector3 &	c_position_offset,
		const CVector3 &	c_passive_field,
		const CVector3 &	c_active_field = `CVector3()`
	)

Definition at line 117 of file magnet_equipped_entity.cpp.

◆ Disable()

void argos::CMagnetEquippedEntity::Disable ( )

virtual

Definition at line 93 of file magnet_equipped_entity.cpp.

◆ Enable()

void argos::CMagnetEquippedEntity::Enable ( )

virtual

Definition at line 83 of file magnet_equipped_entity.cpp.

◆ ENABLE_VTABLE()

argos::CMagnetEquippedEntity::ENABLE_VTABLE ( )

◆ GetInstances()

SInstance::TVector& argos::CMagnetEquippedEntity::GetInstances ( )

inline

Definition at line 86 of file magnet_equipped_entity.h.

◆ GetMagnet()

CMagnetEntity & argos::CMagnetEquippedEntity::GetMagnet ( UInt32 un_index )

Returns an magnet by numeric index.

Parameters

un_index The index of the wanted magnet.

Returns: A magnet by numeric index.

See also: GetAllMagnets()

Definition at line 103 of file magnet_equipped_entity.cpp.

◆ GetTypeDescription()

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

inlinevirtual

Returns a string label for this class.

Returns: A string label for this class.

Reimplemented from argos::CComposableEntity.

Definition at line 90 of file magnet_equipped_entity.h.

◆ Init()

void argos::CMagnetEquippedEntity::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 41 of file magnet_equipped_entity.cpp.

◆ UpdateComponents()

virtual void argos::CMagnetEquippedEntity::UpdateComponents ( )

inlineprotectedvirtual

Calls the Update() method on all the components.

See also: Update()

Reimplemented from argos::CComposableEntity.

Definition at line 96 of file magnet_equipped_entity.h.

Member Data Documentation

◆ m_vecInstances

SInstance::TVector argos::CMagnetEquippedEntity::m_vecInstances

protected

A list of the magnets managed by this entity.

Definition at line 101 of file magnet_equipped_entity.h.

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CMagnetEquippedEntity() [1/2]

◆ CMagnetEquippedEntity() [2/2]

◆ ~CMagnetEquippedEntity()

Member Function Documentation

◆ AddMagnet()

◆ Disable()

◆ Enable()

◆ ENABLE_VTABLE()

◆ GetInstances()

◆ GetMagnet()

◆ GetTypeDescription()

◆ Init()

◆ UpdateComponents()

Member Data Documentation

◆ m_vecInstances