Manage all event agents. More...

#include <eventagentmanager.h>

Inheritance diagram for EMANE::Application::EventAgentManager:

Public Member Functions
virtual	~EventAgentManager ()

virtual void	add (std::unique_ptr< EventAgent > &pAgent)=0

const uuid_t &	getUUID () const

virtual void	initialize (Registrar &registrar)=0

virtual void	configure (const ConfigurationUpdate &update)=0

virtual void	start ()=0

virtual void	postStart ()

virtual void	stop ()=0

virtual void	destroy ()=0 throw ()

BuildId	getBuildId () const

void	setBuildId (BuildId bid)

Protected Member Functions
	EventAgentManager (const uuid_t &uuid)

Protected Attributes
uuid_t	uuid_

Detailed Description

Manage all event agents.

Definition at line 53 of file eventagentmanager.h.

Constructor & Destructor Documentation

◆ ~EventAgentManager()

virtual EMANE::Application::EventAgentManager::~EventAgentManager ( )

inlinevirtual

Destroys an instance

Definition at line 60 of file eventagentmanager.h.

◆ EventAgentManager()

EMANE::Application::EventAgentManager::EventAgentManager ( const uuid_t & uuid )

inlineprotected

Creates an EventGeneratorManager instance

Parameters

uuid	Instance UUID

Definition at line 85 of file eventagentmanager.h.

Member Function Documentation

◆ add()

virtual void EMANE::Application::EventAgentManager::add ( std::unique_ptr< EventAgent > & pAgent )

pure virtual

Add an event agent

Parameters

pAgent EventAgent to add

Implemented in EMANE::Application::EventAgentManagerImpl.

◆ configure()

virtual void EMANE::Component::configure ( const ConfigurationUpdate & update )

pure virtualinherited

Configure the component.

Parameters

update Configuration update values

Exceptions

ConfigureException thrown when a unexpected configuration item is encountered or there is a problem with the specified item value

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ destroy()

virtual void EMANE::Component::destroy	(	)
throw	(
	)

pure virtualinherited

Destroy the component.

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Models::TDMA::EventScheduler, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::FrameworkPHY, EMANE::Application::TransportAdapterImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ getBuildId()

EMANE::BuildId EMANE::Buildable::getBuildId ( ) const

inlineinherited

Gets the application wide unique BuildId of this object.

Returns: the BuildId

Definition at line 34 of file buildable.inl.

◆ getUUID()

const uuid_t& EMANE::Application::EventAgentManager::getUUID ( ) const

inline

Gets the UUID

Returns: UUID

Definition at line 74 of file eventagentmanager.h.

◆ initialize()

virtual void EMANE::Component::initialize ( Registrar & registrar )

pure virtualinherited

Initialize the component.

Exceptions

InitializeException thrown when an error is encountered during initialization

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ postStart()

virtual void EMANE::Component::postStart ( )

inlinevirtualinherited

Hook to run any post start functionaililty. Called after all the components have been started.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::TransportLayer, EMANE::Application::TransportManagerImpl, and EMANE::Models::TDMA::BasicQueueManager.

Definition at line 119 of file component.h.

◆ setBuildId()

void EMANE::Buildable::setBuildId ( BuildId bid )

inlineinherited

Sets the application wide unique BuildId of this object. Builders assign a BuildId to objects at instantiation.

Parameters

bid	the BuildId

Note: : This method is for internal framework use only.

Definition at line 40 of file buildable.inl.

◆ start()

virtual void EMANE::Component::start ( )

pure virtualinherited

Start the component.

Exceptions

StartException thrown when an error is encountered during start.

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::FrameworkPHY, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::Application::TransportManagerImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::ShimLayer, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

◆ stop()

virtual void EMANE::Component::stop ( )

pure virtualinherited

Stop the component.

Exceptions

StopException thrown when an error is encountered during stop

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::Bypass::MACLayer, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::TDMA::EventScheduler, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::FrameworkPHY, EMANE::Application::TransportAdapterImpl, EMANE::Agents::GPSDLocation::Agent, EMANE::Generators::EEL::Generator, EMANE::MACLayer, EMANE::PHYLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, EMANE::Application::TransportManagerImpl, EMANE::ShimLayer, EMANE::TransportLayer, and EMANE::Models::TDMA::BasicQueueManager.

Member Data Documentation

◆ uuid_

uuid_t EMANE::Application::EventAgentManager::uuid_

protected

Definition at line 90 of file eventagentmanager.h.

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

eventagentmanager.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~EventAgentManager()

◆ EventAgentManager()

Member Function Documentation

◆ add()

◆ configure()

◆ destroy()

◆ getBuildId()

◆ getUUID()

◆ initialize()

◆ postStart()

◆ setBuildId()

◆ start()

◆ stop()

Member Data Documentation

◆ uuid_