argos::CPrototypeJointEquippedEntity Class Reference
#include <prototype_joint_equipped_entity.h>
Inheritance diagram for argos::CPrototypeJointEquippedEntity:
Collaboration diagram for argos::CPrototypeJointEquippedEntity:
Public Member Functions | |
| ENABLE_VTABLE () | |
| CPrototypeJointEquippedEntity (CComposableEntity *pc_parent) | |
| virtual | ~CPrototypeJointEquippedEntity () |
| virtual void | Init (TConfigurationNode &t_tree) |
| Initializes the state of the entity from the XML configuration tree. More... | |
| CPrototypeJointEntity & | GetJoint (UInt32 un_index) |
| CPrototypeJointEntity & | GetJoint (const std::string &str_id) |
| CPrototypeJointEntity::TVector & | GetJoints () |
| 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... | |
| 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 |
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
Definition at line 21 of file prototype_joint_equipped_entity.h.
Constructor & Destructor Documentation
◆ CPrototypeJointEquippedEntity()
| argos::CPrototypeJointEquippedEntity::CPrototypeJointEquippedEntity | ( | CComposableEntity * | pc_parent | ) |
Definition at line 14 of file prototype_joint_equipped_entity.cpp.
◆ ~CPrototypeJointEquippedEntity()
|
inlinevirtual |
Definition at line 31 of file prototype_joint_equipped_entity.h.
Member Function Documentation
◆ ENABLE_VTABLE()
| argos::CPrototypeJointEquippedEntity::ENABLE_VTABLE | ( | ) |
◆ GetJoint() [1/2]
| CPrototypeJointEntity & argos::CPrototypeJointEquippedEntity::GetJoint | ( | UInt32 | un_index | ) |
Definition at line 62 of file prototype_joint_equipped_entity.cpp.
◆ GetJoint() [2/2]
| CPrototypeJointEntity & argos::CPrototypeJointEquippedEntity::GetJoint | ( | const std::string & | str_id | ) |
Definition at line 44 of file prototype_joint_equipped_entity.cpp.
◆ GetJoints()
|
inline |
Definition at line 39 of file prototype_joint_equipped_entity.h.
◆ GetTypeDescription()
|
inlinevirtual |
Returns a string label for this class.
- Returns
- A string label for this class.
Reimplemented from argos::CComposableEntity.
Definition at line 43 of file prototype_joint_equipped_entity.h.
◆ Init()
|
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 20 of file prototype_joint_equipped_entity.cpp.