argos::CPrototypeLinkEntity Class Reference

#include <prototype_link_entity.h>

Inheritance diagram for argos::CPrototypeLinkEntity:

Collaboration diagram for argos::CPrototypeLinkEntity:

Public Types
enum	EGeometry { CYLINDER, BOX, SPHERE }
using	TVector = std::vector< CPrototypeLinkEntity * >
using	TVectorIterator = std::vector< CPrototypeLinkEntity * >::iterator
using	TVectorConstIterator = std::vector< CPrototypeLinkEntity * >::const_iterator
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 ()
	CPrototypeLinkEntity (CComposableEntity *pc_parent)
virtual	~CPrototypeLinkEntity ()
virtual void	Init (TConfigurationNode &t_tree)
	Initializes the state of the entity from the XML configuration tree. More...
virtual std::string	GetTypeDescription () const
	Returns a string label for this class. More...
EGeometry	GetGeometry () const
const CVector3 &	GetExtents () const
Real	GetMass () const
SAnchor &	GetAnchor ()
const SAnchor &	GetAnchor () const
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	Reset ()
	Resets the state of the entity to whatever it was after Init() or the standalone constructor was called. 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 21 of file prototype_link_entity.h.

Member Typedef Documentation

using argos::CPrototypeLinkEntity::TVector = std::vector<CPrototypeLinkEntity*>

Definition at line 27 of file prototype_link_entity.h.

using argos::CPrototypeLinkEntity::TVectorConstIterator = std::vector<CPrototypeLinkEntity*>::const_iterator

Definition at line 29 of file prototype_link_entity.h.

using argos::CPrototypeLinkEntity::TVectorIterator = std::vector<CPrototypeLinkEntity*>::iterator

Definition at line 28 of file prototype_link_entity.h.

Member Enumeration Documentation

enum argos::CPrototypeLinkEntity::EGeometry

Enumerator
CYLINDER
BOX
SPHERE

Definition at line 32 of file prototype_link_entity.h.

Constructor & Destructor Documentation

argos::CPrototypeLinkEntity::CPrototypeLinkEntity

(

CComposableEntity *

pc_parent

)

Definition at line 16 of file prototype_link_entity.cpp.

virtual argos::CPrototypeLinkEntity::~CPrototypeLinkEntity ( )

inlinevirtual

Definition at line 42 of file prototype_link_entity.h.

Member Function Documentation

argos::CPrototypeLinkEntity::ENABLE_VTABLE

(

)

SAnchor& argos::CPrototypeLinkEntity::GetAnchor ( )

inline

Definition at line 62 of file prototype_link_entity.h.

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

inline

Definition at line 66 of file prototype_link_entity.h.

const CVector3& argos::CPrototypeLinkEntity::GetExtents ( ) const

inline

Definition at line 54 of file prototype_link_entity.h.

EGeometry argos::CPrototypeLinkEntity::GetGeometry ( ) const

inline

Definition at line 50 of file prototype_link_entity.h.

Real argos::CPrototypeLinkEntity::GetMass ( ) const

inline

Definition at line 58 of file prototype_link_entity.h.

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

inlinevirtual

Returns a string label for this class.

Returns

A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 46 of file prototype_link_entity.h.

void argos::CPrototypeLinkEntity::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 26 of file prototype_link_entity.cpp.