EMANE::Application::EventAgentBuilder Class Reference

Provides methods for constructing event agents and a manager to contain and control them as a group. More...

#include <eventagentbuilder.h>

Public Member Functions
	EventAgentBuilder ()
	~EventAgentBuilder ()
std::unique_ptr< EventAgentManager >	buildEventAgentManager (const uuid_t &uuid, EventAgents &agents, const ConfigurationUpdateRequest &request)
std::unique_ptr< EventAgent >	buildEventAgent (EMANE::NEMId nemId, const std::string &sLibraryFile, const ConfigurationUpdateRequest &request, bool bSkipConfigure=false)

Detailed Description

Provides methods for constructing event agents and a manager to contain and control them as a group.

Definition at line 56 of file eventagentbuilder.h.

Constructor & Destructor Documentation

EventAgentBuilder()

EMANE::Application::EventAgentBuilder::EventAgentBuilder

(

)

Creates an instance

Definition at line 47 of file eventagentbuilder.cc.

~EventAgentBuilder()

EMANE::Application::EventAgentBuilder::~EventAgentBuilder

(

)

Destroys an instance

Definition at line 49 of file eventagentbuilder.cc.

Member Function Documentation

buildEventAgent()

std::unique_ptr< EMANE::EventAgent > EMANE::Application::EventAgentBuilder::buildEventAgent	(	EMANE::NEMId	nemId,
		const std::string &	sLibraryFile,
		const ConfigurationUpdateRequest &	request,
		bool	bSkipConfigure = false
	)

Builds an EventAgent

Parameters

nemId	NEM id of the nem for which this event agent is being created
sLibraryFile	Name of the dll containing the generator
request	configuration update
bSkipConfigure	Flag indicating whether to skip calling Component::configure

Returns

Unique pointer to an initialized and configured EventAgent

Exceptions

Utils::FactoryException	when a DLL load error occurs.
InitializeException	when an error occurs during initialization.
ConfigureException	when an error occurs during configure.

Definition at line 84 of file eventagentbuilder.cc.

buildEventAgentManager()

std::unique_ptr< EMANE::Application::EventAgentManager > EMANE::Application::EventAgentBuilder::buildEventAgentManager	(	const uuid_t &	uuid,
		EventAgents &	agents,
		const ConfigurationUpdateRequest &	request
	)

Builds an EventAgentManager

Parameters

uuid	Instance UUID
agents	the list of agents to manage
request	configuration update

Returns

Unique pointer to an initialized and configured EventAgentManager

Exceptions

InitializeException	when an error occurs during initialization.
BuildException	when an error occurs building an NEM from the specified layers.
ConfigureException	when an error occurs during configure.

Definition at line 52 of file eventagentbuilder.cc.

---

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

• eventagentbuilder.h
• eventagentbuilder.cc