#include <radio_entity.h>

Inheritance diagram for argos::CRadioEntity:

Public Types
typedef std::vector< CRadioEntity * >	TList

Public Types inherited from argos::CEntity
typedef std::vector< CEntity * >	TVector
	A vector of entities.

typedef unordered_map< std::string, CEntity * >	TMap
	A map of entities.

typedef std::multimap< std::string, CEntity * >	TMultiMap
	A multi-map of entities.

Public Member Functions
	ENABLE_VTABLE ()

	CRadioEntity (CComposableEntity *pc_parent)

	CRadioEntity (CComposableEntity *pc_parent, const std::string &str_id, Real f_transmit_range)

virtual	~CRadioEntity ()

virtual void	Init (TConfigurationNode &t_tree)
	Initializes the state of the entity from the XML configuration tree.

virtual void	Reset ()
	Resets the state of the entity to whatever it was after Init() or the standalone constructor was called.

virtual void	Destroy ()
	Destroys the entity, undoing whatever was done by Init() or by the standalone constructor.

virtual void	SetEnabled (bool b_enabled)
	Enables or disables an entity.

const std::vector< std::pair< CVector3, CByteArray > > &	GetData () const
	Returns a constant reference to the received data.

std::vector< std::pair< CVector3, CByteArray > > &	GetData ()
	Returns a reference to the received data.

void	ReceiveData (const CVector3 &c_tx_location, const CByteArray &c_tx_data)
	Adds data received by the radio.

bool	HasData () const
	Checks if there has been data received by the radio.

Real	GetRange () const
	Returns the transmission range of the radio.

void	SetRange (Real f_range)
	Sets the tranmission range of the radio.

virtual std::string	GetTypeDescription () const
	Returns a string label for this class.

bool	HasMedium () const
	Returns `true` if this radio is associated to a medium.

CRadioMedium &	GetMedium () const
	Returns the medium associated to this radio.

void	SetMedium (CRadioMedium &c_medium)
	Sets the medium associated to this entity.

Public Member Functions inherited from argos::CPositionalEntity
	ENABLE_VTABLE ()

	CPositionalEntity (CComposableEntity *pc_parent)

	CPositionalEntity (CComposableEntity *pc_parent, const std::string &str_id, const CVector3 &c_position=CVector3(), const CQuaternion &c_orientation=CQuaternion())

const CVector3 &	GetPosition () const

const CVector3 &	GetInitPosition () const

void	SetPosition (const CVector3 &c_position)

void	SetInitPosition (const CVector3 &c_position)

const CQuaternion &	GetOrientation () const

const CQuaternion &	GetInitOrientation () const

void	SetOrientation (const CQuaternion c_orientation)

void	SetInitOrientation (const CQuaternion c_orientation)

virtual void	MoveTo (const CVector3 &c_position, const CQuaternion &c_orientation)

Public Member Functions inherited from argos::CEntity
	ENABLE_VTABLE ()

	CEntity (CComposableEntity *pc_parent)
	Class constructor.

	CEntity (CComposableEntity *pc_parent, const std::string &str_id)
	Class constructor.

virtual	~CEntity ()
	Class destructor.

const std::string &	GetId () const
	Returns the id of this entity.

std::string	GetContext () const
	Returns the context of this entity.

bool	HasParent () const
	Returns `true` if this entity has a parent.

CEntity &	GetRootEntity ()
	Returns the root entity containing this entity.

const CEntity &	GetRootEntity () const
	Returns the root entity containing this entity.

CComposableEntity &	GetParent ()
	Returns this entity's parent.

const CComposableEntity &	GetParent () const
	Returns this entity's parent.

void	SetParent (CComposableEntity &c_parent)
	Sets this entity's parent.

virtual void	Update ()
	Updates the state of this entity.

ssize_t	GetIndex () const
	Returns the entity index.

void	SetIndex (ssize_t n_idx)
	Sets the entity index.

bool	IsEnabled () const
	Returns `true` if the entity is enabled.

void	Enable ()
	Enables the entity.

void	Disable ()
	Disables the entity.

TConfigurationNode *	GetConfigurationNode ()
	Returns a pointer to the configuration node that was used to create this entity.

Public Member Functions inherited from argos::CBaseConfigurableResource
virtual	~CBaseConfigurableResource ()
	Class destructor.

Public Member Functions inherited from argos::EnableVTableFor< CEntity >
size_t	GetTagHelper (const DERIVED *) const

Protected Attributes
Real	m_fRange

std::vector< std::pair< CVector3, CByteArray > >	m_vecData

CRadioMedium *	m_pcMedium

Detailed Description

Definition at line 24 of file radio_entity.h.

Member Typedef Documentation

◆ TList

std::vector<CRadioEntity*> argos::CRadioEntity::TList

Definition at line 32 of file radio_entity.h.

Constructor & Destructor Documentation

◆ CRadioEntity() [1/2]

argos::CRadioEntity::CRadioEntity ( CComposableEntity * pc_parent )

Definition at line 17 of file radio_entity.cpp.

◆ CRadioEntity() [2/2]

argos::CRadioEntity::CRadioEntity	(	CComposableEntity *	pc_parent,
		const std::string &	str_id,
		Real	f_transmit_range )

Definition at line 25 of file radio_entity.cpp.

◆ ~CRadioEntity()

virtual argos::CRadioEntity::~CRadioEntity ( )

inlinevirtual

Definition at line 42 of file radio_entity.h.

Member Function Documentation

◆ Destroy()

void argos::CRadioEntity::Destroy ( )

virtual

Destroys the entity, undoing whatever was done by Init() or by the standalone constructor.

The default implementation of this method does nothing.

Reimplemented from argos::CEntity.

Definition at line 57 of file radio_entity.cpp.

◆ ENABLE_VTABLE()

argos::CRadioEntity::ENABLE_VTABLE ( )

◆ GetData() [1/2]

std::vector< std::pair< CVector3, CByteArray > > & argos::CRadioEntity::GetData ( )

inline

Returns a reference to the received data.

Returns: A reference to the received data.

See also: ReceiveData()

Definition at line 66 of file radio_entity.h.

◆ GetData() [2/2]

const std::vector< std::pair< CVector3, CByteArray > > & argos::CRadioEntity::GetData ( ) const

inline

Returns a constant reference to the received data.

Returns: A constant reference to the received data.

See also: ReceiveData()

Definition at line 57 of file radio_entity.h.

◆ GetMedium()

CRadioMedium & argos::CRadioEntity::GetMedium ( ) const

Returns the medium associated to this radio.

Returns: The medium associated to this radio.

See also: CRadioMedium

Definition at line 82 of file radio_entity.cpp.

◆ GetRange()

Real argos::CRadioEntity::GetRange ( ) const

inline

Returns the transmission range of the radio.

Returns: the transmission range of the radio.

See also: SetRange()

Definition at line 94 of file radio_entity.h.

◆ GetTypeDescription()

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

inlinevirtual

Returns a string label for this class.

Returns: A string label for this class.

Reimplemented from argos::CPositionalEntity.

Definition at line 107 of file radio_entity.h.

◆ HasData()

bool argos::CRadioEntity::HasData ( ) const

inline

Checks if there has been data received by the radio.

Returns: A boolean value representing whether data has been received

See also: GetData(); ClearData()

Definition at line 85 of file radio_entity.h.

◆ HasMedium()

bool argos::CRadioEntity::HasMedium ( ) const

inline

Returns true if this radio is associated to a medium.

Returns: true if this radio is associated to a medium.

See also: CRadioMedium

Definition at line 116 of file radio_entity.h.

◆ Init()

void argos::CRadioEntity::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::CPositionalEntity.

Definition at line 35 of file radio_entity.cpp.

◆ ReceiveData()

void argos::CRadioEntity::ReceiveData	(	const CVector3 &	c_tx_location,
		const CByteArray &	c_tx_data )

inline

Adds data received by the radio.

Parameters

c_data a pair containing the data to be received and its origin.

See also: GetData()

Definition at line 75 of file radio_entity.h.

◆ Reset()

void argos::CRadioEntity::Reset ( )

virtual

Resets the state of the entity to whatever it was after Init() or the standalone constructor was called.

The default implementation of this method does nothing.

Reimplemented from argos::CPositionalEntity.

Definition at line 49 of file radio_entity.cpp.

◆ SetEnabled()

void argos::CRadioEntity::SetEnabled ( bool b_enabled )

virtual

Enables or disables an entity.

Parameters

b_enabled true if the entity is enabled, false otherwise

See also: m_bEnabled; m_bCanBeEnabledIfDisabled

Reimplemented from argos::CEntity.

Definition at line 64 of file radio_entity.cpp.

◆ SetMedium()

void argos::CRadioEntity::SetMedium ( CRadioMedium & c_medium )

Sets the medium associated to this entity.

Parameters

c_medium The medium to associate to this entity.

See also: CRadioMedium

Definition at line 93 of file radio_entity.cpp.

◆ SetRange()

void argos::CRadioEntity::SetRange ( Real f_range )

inline

Sets the tranmission range of the radio.

Parameters

f_range the new transmission range of the radio in metres.

See also: GetRange()

Definition at line 103 of file radio_entity.h.

Member Data Documentation

◆ m_fRange

Real argos::CRadioEntity::m_fRange

protected

Definition at line 136 of file radio_entity.h.

◆ m_pcMedium

CRadioMedium* argos::CRadioEntity::m_pcMedium

protected

Definition at line 138 of file radio_entity.h.

◆ m_vecData

std::vector<std::pair<CVector3, CByteArray> > argos::CRadioEntity::m_vecData

protected

Definition at line 137 of file radio_entity.h.

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

plugins/simulator/entities/radio_entity.h
plugins/simulator/entities/radio_entity.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TList

Constructor & Destructor Documentation

◆ CRadioEntity() [1/2]

◆ CRadioEntity() [2/2]

◆ ~CRadioEntity()

Member Function Documentation

◆ Destroy()

◆ ENABLE_VTABLE()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetMedium()

◆ GetRange()

◆ GetTypeDescription()

◆ HasData()

◆ HasMedium()

◆ Init()

◆ ReceiveData()

◆ Reset()

◆ SetEnabled()

◆ SetMedium()

◆ SetRange()

Member Data Documentation

◆ m_fRange

◆ m_pcMedium

◆ m_vecData