ARGoS  3
A parallel, multi-engine simulator for swarm robotics
argos::COmnidirectionalCameraEquippedEntity Class Reference

#include <omnidirectional_camera_equipped_entity.h>

+ Inheritance diagram for argos::COmnidirectionalCameraEquippedEntity:

List of all members.

Public Member Functions

 ENABLE_VTABLE ()
 COmnidirectionalCameraEquippedEntity (CComposableEntity *pc_parent)
 Class constructor.
 COmnidirectionalCameraEquippedEntity (CComposableEntity *pc_parent, const std::string &str_id, const CRadians &c_aperture, const CVector3 &c_offset)
 Class constructor.
virtual void Init (TConfigurationNode &t_tree)
 Initializes the state of the entity from the XML configuration tree.
const CVector3GetOffset () const
 Returns the offset of the omnidirectional camera with respect to the reference point.
void SetOffset (const CVector3 &c_offset)
 Sets the offset of the omnidirectionalcamera with respect to the reference point.
const CRadiansGetAperture () const
 Returns the aperture of the visibility cone of the omnidirectional camera.
void SetAperture (const CRadians &c_aperture)
 Sets the aperture of the visibility cone of the omnidirectional camera.
virtual std::string GetTypeDescription () const
 Returns a string label for this class.

Detailed Description

Definition at line 21 of file omnidirectional_camera_equipped_entity.h.


Constructor & Destructor Documentation

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 16 of file omnidirectional_camera_equipped_entity.cpp.


Member Function Documentation

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.

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 [inline, virtual]

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.

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

Exceptions:
CARGoSExceptionif a parse error occurs

Reimplemented from argos::CEntity.

Definition at line 28 of file omnidirectional_camera_equipped_entity.cpp.

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.

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.


The documentation for this class was generated from the following files: