Provides methods for constructing an emulator instance from its constituent parts. More...

#include <nembuilder.h>

Public Member Functions
	NEMBuilder ()

	~NEMBuilder ()

std::unique_ptr< NEMLayer >	buildPHYLayer (NEMId id, const std::string &sLibraryFile, const ConfigurationUpdateRequest &request, bool bSkipConfigure=false)

std::unique_ptr< NEMLayer >	buildMACLayer (NEMId id, const std::string &sLibraryFile, const ConfigurationUpdateRequest &request, bool bSkipConfigure=false)

std::unique_ptr< NEMLayer >	buildShimLayer (NEMId id, const std::string &sLibraryFile, const ConfigurationUpdateRequest &request, bool bSkipConfigure=false)

std::unique_ptr< NEMLayer >	buildTransportLayer (NEMId id, const std::string &sLibraryFile, const ConfigurationUpdateRequest &request, bool bSkipConfigure=false)

std::unique_ptr< NEM >	buildNEM (NEMId id, NEMLayers &layers, const ConfigurationUpdateRequest &request, bool bHasExternalTransport)

std::unique_ptr< NEMManager >	buildNEMManager (const uuid_t &uuid, NEMs &nems, const ConfigurationUpdateRequest &request)

Detailed Description

Provides methods for constructing an emulator instance from its constituent parts.

Definition at line 60 of file nembuilder.h.

Constructor & Destructor Documentation

◆ NEMBuilder()

EMANE::Application::NEMBuilder::NEMBuilder ( )

Definition at line 81 of file nembuilder.cc.

◆ ~NEMBuilder()

EMANE::Application::NEMBuilder::~NEMBuilder ( )

Definition at line 84 of file nembuilder.cc.

Member Function Documentation

◆ buildMACLayer()

std::unique_ptr< EMANE::NEMLayer > EMANE::Application::NEMBuilder::buildMACLayer	(	NEMId	id,
		const std::string &	sLibraryFile,
		const ConfigurationUpdateRequest &	request,
		bool	bSkipConfigure = `false`
	)

Builds a MAC layer

Parameters

id	id of the NEM that will contain the mac
sLibraryFile	Name of the dll containing the layer
request	Configuration update request
bSkipConfigure	Flag indicating whether to skip calling Component::configure

Returns: Unique pointer to an initialized MAC

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 159 of file nembuilder.cc.

◆ buildNEM()

std::unique_ptr< EMANE::Application::NEM > EMANE::Application::NEMBuilder::buildNEM	(	NEMId	id,
		NEMLayers &	layers,
		const ConfigurationUpdateRequest &	request,
		bool	bHasExternalTransport
	)

Builds an NEM

Parameters

id	NEM id
layers	The NEMLayers comprising the NEM
request	Configuration update request
bHasExternalTransport	Flag indicating whether transport is external

Returns: Unique pointer to an initialized NEM

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 281 of file nembuilder.cc.

◆ buildNEMManager()

std::unique_ptr< EMANE::Application::NEMManager > EMANE::Application::NEMBuilder::buildNEMManager	(	const uuid_t &	uuid,
		NEMs &	nems,
		const ConfigurationUpdateRequest &	request
	)

Builds an NEM Manager

Parameters

uuid	Instance UUID
nems	The NEMs comprising the Platform
request	Configuration update request

Returns: Unique pointer to an initialized Platform

Exceptions

Utils::FactoryException	when a DLL load error occurs.
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 324 of file nembuilder.cc.

◆ buildPHYLayer()

std::unique_ptr< EMANE::NEMLayer > EMANE::Application::NEMBuilder::buildPHYLayer	(	NEMId	id,
		const std::string &	sLibraryFile,
		const ConfigurationUpdateRequest &	request,
		bool	bSkipConfigure = `false`
	)

Builds a PHY layer

Parameters

id	id of the NEM that will contain the phy
sLibraryFile	Name of the dll containing the layer
request	Configuration update request
bSkipConfigure	Flag indicating whether to skip calling Component::configure

Returns: Unique pointer to an initialized PHY

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 87 of file nembuilder.cc.

◆ buildShimLayer()

std::unique_ptr< EMANE::NEMLayer > EMANE::Application::NEMBuilder::buildShimLayer	(	NEMId	id,
		const std::string &	sLibraryFile,
		const ConfigurationUpdateRequest &	request,
		bool	bSkipConfigure = `false`
	)

Builds a Shim layer

Parameters

id	id of the NEM that will contain the shim
sLibraryFile	Name of the dll containing the layer
request	Configuration update request
bSkipConfigure	Flag indicating whether to skip calling Component::configure

Returns: Unique pointer to an initialized and configured Shim

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 220 of file nembuilder.cc.

◆ buildTransportLayer()

std::unique_ptr< EMANE::NEMLayer > EMANE::Application::NEMBuilder::buildTransportLayer	(	NEMId	id,
		const std::string &	sLibraryFile,
		const ConfigurationUpdateRequest &	request,
		bool	bSkipConfigure = `false`
	)

Builds a Transport layer

Parameters

id	id of the NEM that will contain the transport
sLibraryFile	Name of the dll containing the layer
request	Configuration update request
bSkipConfigure	Flag indicating whether to skip calling Component::configure

Returns: Unique pointer to an initialized and configured Transport

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 355 of file nembuilder.cc.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NEMBuilder()

◆ ~NEMBuilder()

Member Function Documentation

◆ buildMACLayer()

◆ buildNEM()

◆ buildNEMManager()

◆ buildPHYLayer()

◆ buildShimLayer()

◆ buildTransportLayer()