argos::COmnidirectionalCameraEquippedEntity Class Reference

#include <omnidirectional_camera_equipped_entity.h>

Inheritance diagram for argos::COmnidirectionalCameraEquippedEntity:
Collaboration diagram for argos::COmnidirectionalCameraEquippedEntity:

Public Member Functions

 ENABLE_VTABLE ()
 
 COmnidirectionalCameraEquippedEntity (CComposableEntity *pc_parent)
 Class constructor. More...
 
 COmnidirectionalCameraEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id, const CRadians &c_aperture, const CVector3 &c_offset)
 Class constructor. More...
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree. More...
 
const CVector3GetOffset () const
 Returns the offset of the omnidirectional camera with respect to the reference point. More...
 
void SetOffset (const CVector3 &c_offset)
 Sets the offset of the omnidirectionalcamera with respect to the reference point. More...
 
const CRadiansGetAperture () const
 Returns the aperture of the visibility cone of the omnidirectional camera. More...
 
void SetAperture (const CRadians &c_aperture)
 Sets the aperture of the visibility cone of the omnidirectional camera. More...
 
virtual std::string GetTypeDescription () const
 Returns a string label for this class. 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 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...
 
CEntityGetRootEntity ()
 Returns the root entity containing this entity. More...
 
const CEntityGetRootEntity () const
 Returns the root entity containing this entity. More...
 
CComposableEntityGetParent ()
 Returns this entity's parent. More...
 
const CComposableEntityGetParent () 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...
 
TConfigurationNodeGetConfigurationNode ()
 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 omnidirectional_camera_equipped_entity.h.

Constructor & Destructor Documentation

argos::COmnidirectionalCameraEquippedEntity::COmnidirectionalCameraEquippedEntity ( CComposableEntity pc_parent)

Class constructor.

This constructor is meant to be used with the Init() method.

Parameters
pc_parentThe parent of this entity.

Definition at line 9 of file omnidirectional_camera_equipped_entity.cpp.

argos::COmnidirectionalCameraEquippedEntity::COmnidirectionalCameraEquippedEntity ( CComposableEntity pc_parent,
const std::string &  str_id,
const CRadians c_aperture,
const CVector3 c_offset 
)

Class constructor.

This constructor is meant to be standalone. You should not call Init() after using this constructor, or memory leaks are likely to happen.

Parameters
pc_parentThe parent of this entity.
str_idThe id of this entity.
c_apertureThe aperture of the visibility cone
c_offsetThe positional offset of this omnidirectionalcamera with respect to the robot reference point.

Definition at line 17 of file omnidirectional_camera_equipped_entity.cpp.

Member Function Documentation

argos::COmnidirectionalCameraEquippedEntity::ENABLE_VTABLE ( )
const CRadians& argos::COmnidirectionalCameraEquippedEntity::GetAperture ( ) const
inline

Returns the aperture of the visibility cone of the omnidirectional camera.

Returns
The aperture of the visibility cone of the omnidirectional camera.

Definition at line 77 of file omnidirectional_camera_equipped_entity.h.

const CVector3& argos::COmnidirectionalCameraEquippedEntity::GetOffset ( ) const
inline

Returns the offset of the omnidirectional camera with respect to the reference point.

Returns
The offset of the omnidirectional camera with respect to the reference point.

Definition at line 61 of file omnidirectional_camera_equipped_entity.h.

virtual std::string argos::COmnidirectionalCameraEquippedEntity::GetTypeDescription ( ) const
inlinevirtual

Returns a string label for this class.

Returns
A string label for this class.

Reimplemented from argos::CEntity.

Definition at line 89 of file omnidirectional_camera_equipped_entity.h.

void argos::COmnidirectionalCameraEquippedEntity::Init ( TConfigurationNode t_tree)
virtual

Initializes the state of the entity from the XML configuration tree.

Exceptions
CARGoSExceptionif a parse error occurs

Reimplemented from argos::CEntity.

Definition at line 30 of file omnidirectional_camera_equipped_entity.cpp.

void argos::COmnidirectionalCameraEquippedEntity::SetAperture ( const CRadians c_aperture)
inline

Sets the aperture of the visibility cone of the omnidirectional camera.

Parameters
c_apertureThe aperture of the visibility cone of the omnidirectional camera.

Definition at line 85 of file omnidirectional_camera_equipped_entity.h.

void argos::COmnidirectionalCameraEquippedEntity::SetOffset ( const CVector3 c_offset)
inline

Sets the offset of the omnidirectionalcamera with respect to the reference point.

Parameters
c_offsetThe offset of the omnidirectionalcamera with respect to the reference point.

Definition at line 69 of file omnidirectional_camera_equipped_entity.h.