#include <prototype_joint_entity.h>

Inheritance diagram for argos::CPrototypeJointEntity:

Collaboration diagram for argos::CPrototypeJointEntity:

Classes
struct	SActuator

struct	SSensor

union	ULimit

Public Types
enum	EType { EType::FIXED, EType::PRISMATIC, EType::REVOLUTE, EType::SPHERICAL, EType::PLANAR }

using	TVector = std::vector< CPrototypeJointEntity * >

using	TVectorIterator = std::vector< CPrototypeJointEntity * >::iterator

using	TVectorConstIterator = std::vector< CPrototypeJointEntity * >::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 ()

	CPrototypeJointEntity (CComposableEntity *pc_parent)

virtual	~CPrototypeJointEntity ()

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

CPrototypeLinkEntity &	GetParentLink ()

const CPrototypeLinkEntity &	GetParentLink () const

const CVector3 &	GetParentLinkJointPosition () const

const CQuaternion &	GetParentLinkJointOrientation () const

CPrototypeLinkEntity &	GetChildLink ()

const CPrototypeLinkEntity &	GetChildLink () const

const CVector3 &	GetChildLinkJointPosition () const

const CQuaternion &	GetChildLinkJointOrientation () const

bool	GetDisableCollision () const

EType	GetType () const

const CVector3 &	GetJointAxis () const

bool	HasLimit ()

const ULimit &	GetLimit () const

SSensor &	GetSensor ()

SActuator &	GetActuator ()

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

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

Detailed Description

Definition at line 21 of file prototype_joint_entity.h.

Member Typedef Documentation

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

Definition at line 27 of file prototype_joint_entity.h.

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

Definition at line 29 of file prototype_joint_entity.h.

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

Definition at line 28 of file prototype_joint_entity.h.

Member Enumeration Documentation

enum argos::CPrototypeJointEntity::EType

strong

Enumerator
FIXED
PRISMATIC
REVOLUTE
SPHERICAL
PLANAR

Definition at line 32 of file prototype_joint_entity.h.

Constructor & Destructor Documentation

argos::CPrototypeJointEntity::CPrototypeJointEntity ( CComposableEntity * pc_parent )

Definition at line 15 of file prototype_joint_entity.cpp.

virtual argos::CPrototypeJointEntity::~CPrototypeJointEntity ( )

inlinevirtual

Definition at line 71 of file prototype_joint_entity.h.

Member Function Documentation

argos::CPrototypeJointEntity::ENABLE_VTABLE ( )

SActuator& argos::CPrototypeJointEntity::GetActuator ( )

inline

Definition at line 139 of file prototype_joint_entity.h.

CPrototypeLinkEntity& argos::CPrototypeJointEntity::GetChildLink ( )

inline

Definition at line 95 of file prototype_joint_entity.h.

const CPrototypeLinkEntity& argos::CPrototypeJointEntity::GetChildLink ( ) const

inline

Definition at line 99 of file prototype_joint_entity.h.

const CQuaternion& argos::CPrototypeJointEntity::GetChildLinkJointOrientation ( ) const

inline

Definition at line 107 of file prototype_joint_entity.h.

const CVector3& argos::CPrototypeJointEntity::GetChildLinkJointPosition ( ) const

inline

Definition at line 103 of file prototype_joint_entity.h.

bool argos::CPrototypeJointEntity::GetDisableCollision ( ) const

inline

Definition at line 111 of file prototype_joint_entity.h.

const CVector3& argos::CPrototypeJointEntity::GetJointAxis ( ) const

inline

Definition at line 119 of file prototype_joint_entity.h.

const ULimit& argos::CPrototypeJointEntity::GetLimit ( ) const

inline

Definition at line 127 of file prototype_joint_entity.h.

CPrototypeLinkEntity& argos::CPrototypeJointEntity::GetParentLink ( )

inline

Definition at line 79 of file prototype_joint_entity.h.

const CPrototypeLinkEntity& argos::CPrototypeJointEntity::GetParentLink ( ) const

inline

Definition at line 83 of file prototype_joint_entity.h.

const CQuaternion& argos::CPrototypeJointEntity::GetParentLinkJointOrientation ( ) const

inline

Definition at line 91 of file prototype_joint_entity.h.

const CVector3& argos::CPrototypeJointEntity::GetParentLinkJointPosition ( ) const

inline

Definition at line 87 of file prototype_joint_entity.h.

SSensor& argos::CPrototypeJointEntity::GetSensor ( )

inline

Definition at line 135 of file prototype_joint_entity.h.

EType argos::CPrototypeJointEntity::GetType ( ) const

inline

Definition at line 115 of file prototype_joint_entity.h.

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

inlinevirtual

Returns a string label for this class.

Returns: A string label for this class.

Reimplemented from argos::CComposableEntity.

Definition at line 75 of file prototype_joint_entity.h.

bool argos::CPrototypeJointEntity::HasLimit ( )

inline

Definition at line 123 of file prototype_joint_entity.h.

void argos::CPrototypeJointEntity::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 31 of file prototype_joint_entity.cpp.

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation