Contains all configuration associated with an NEM. More...

#include <nemconfiguration.h>

Inheritance diagram for EMANE::NEMConfiguration:

Public Types
enum	NEMType { STRUCTURED, UNSTRUCTURED, INVALID }

Public Member Functions
	NEMConfiguration (xmlNodePtr pNEMNode, const std::string sDefinitionURI)

	~NEMConfiguration ()

NEMId	getNEMId ()

const LayerConfigurations &	getLayers ()

bool	isValid ()

bool	isExternalTransport ()

const ConfigurationUpdateRequest	getConfigurationUpdateRequest ()

std::string	getType () const

std::string	getLibrary () const

std::string	getDefinitionPath () const

std::string	getDefinitionFile () const

void	overlayParams (xmlNodePtr pNode)

Protected Member Functions
void	doProcessRootAttributes (xmlNodePtr pRoot)

void	doProcessChildNode (xmlNodePtr pNode)

void	processDefinition (const char *pxzName, const std::string &sURI)

virtual void	doProcessChildren (xmlNodePtr pParent, ParamMap &paramMap)

void	doProcessParam (ParamMap &paramMap, xmlNodePtr pParamNode)

void	doProcessParamlist (ParamMap &paramMap, xmlNodePtr pParamlistNode)

std::string	getAttrVal (xmlNodePtr pNode, const char *attributename)

std::uint16_t	getAttrValNumeric (xmlNodePtr pNode, const char *attributename)

void	setPathAndFile (const std::string sURI)

Protected Attributes
std::string	sName_

std::string	sLibrary_

ParamMap	params_

Detailed Description

Contains all configuration associated with an NEM.

See also: LayerConfiguration

Definition at line 56 of file nemconfiguration.h.

Member Enumeration Documentation

◆ NEMType

enum EMANE::NEMConfiguration::NEMType

Enumerator
STRUCTURED
UNSTRUCTURED
INVALID

Definition at line 60 of file nemconfiguration.h.

Constructor & Destructor Documentation

◆ NEMConfiguration()

EMANE::NEMConfiguration::NEMConfiguration	(	xmlNodePtr	pNEMNode,
		const std::string	sDefinitionURI
	)

Constructor

Parameters

pNEMNode	Pointer to the Root node of this NEM
sDefinitionURI	URI of the NEM definition file

Exceptions

ParseException

ValidateException

Definition at line 42 of file nemconfiguration.cc.

◆ ~NEMConfiguration()

EMANE::NEMConfiguration::~NEMConfiguration ( )

Destructor

Definition at line 59 of file nemconfiguration.cc.

Member Function Documentation

◆ doProcessChildNode()

void EMANE::NEMConfiguration::doProcessChildNode ( xmlNodePtr pNode )

protectedvirtual

Does processing of a child node as if it was a 'layer'

Parameters

pNode Pointer to the node

Exceptions

ParseException

ValidateException

Reimplemented from EMANE::LayerConfiguration.

Definition at line 108 of file nemconfiguration.cc.

◆ doProcessChildren()

void EMANE::LayerConfiguration::doProcessChildren	(	xmlNodePtr	pParent,
		ParamMap &	paramMap
	)

protectedvirtualinherited

Process the children of the specifie node

Parameters

pParent	Pointer to the parent
paramMap	Parameter map

Exceptions

ParseException

ValidateException

Definition at line 93 of file layerconfiguration.cc.

◆ doProcessParam()

void EMANE::LayerConfiguration::doProcessParam	(	ParamMap &	paramMap,
		xmlNodePtr	pParamNode
	)

protectedinherited

Parse the param node

Parameters

paramMap	to store parsed value
pParamNode	Pointer to the param node

Definition at line 132 of file layerconfiguration.cc.

◆ doProcessParamlist()

void EMANE::LayerConfiguration::doProcessParamlist	(	ParamMap &	paramMap,
		xmlNodePtr	pParamlistNode
	)

protectedinherited

Parse the param node

Parameters

paramMap	to store parsed values
pParamlistNode	Pointer to the param list node

Definition at line 153 of file layerconfiguration.cc.

◆ doProcessRootAttributes()

void EMANE::NEMConfiguration::doProcessRootAttributes ( xmlNodePtr pRoot )

protectedvirtual

Does processing of the root node as if it was an 'nem'

Parameters

pRoot Pointer to the root node

Exceptions

ParseException

ValidateException

Reimplemented from EMANE::LayerConfiguration.

Definition at line 98 of file nemconfiguration.cc.

◆ getAttrVal()

std::string EMANE::LayerConfiguration::getAttrVal	(	xmlNodePtr	pNode,
		const char *	attributename
	)

protectedinherited

Get the value of the attribute of the passed node

Parameters

pNode	Pointer to the xml Node
attributename	Name of the attribute to retrieve

Returns: String value of named attribute

Definition at line 185 of file layerconfiguration.cc.

◆ getAttrValNumeric()

std::uint16_t EMANE::LayerConfiguration::getAttrValNumeric	(	xmlNodePtr	pNode,
		const char *	attributename
	)

protectedinherited

Get the numeric value of the attribute of the passed node

Parameters

pNode	Pointer to the xml Node
attributename	Name of the attribute to retrieve

Returns: Numeric value of the named attribute

Definition at line 205 of file layerconfiguration.cc.

◆ getConfigurationUpdateRequest()

const EMANE::ConfigurationUpdateRequest EMANE::LayerConfiguration::getConfigurationUpdateRequest ( )

inherited

Return A ConfigurationUpdateRequest built from the XML contents

Returns: A ConfigurationUpdateRequest built from the XML contents

Definition at line 233 of file layerconfiguration.cc.

◆ getDefinitionFile()

std::string EMANE::LayerConfiguration::getDefinitionFile ( ) const

inherited

Returns the name of the definition file

Returns: Path the name of the definition file

Definition at line 268 of file layerconfiguration.cc.

◆ getDefinitionPath()

std::string EMANE::LayerConfiguration::getDefinitionPath ( ) const

inherited

Returns the path to the definition file

Returns: Path to the definition file

Definition at line 261 of file layerconfiguration.cc.

◆ getLayers()

const EMANE::LayerConfigurations & EMANE::NEMConfiguration::getLayers ( )

Returns the container with Layers

Returns: Container with Layer (phy/mac/shim/transport) config objects

Definition at line 75 of file nemconfiguration.cc.

◆ getLibrary()

std::string EMANE::LayerConfiguration::getLibrary ( ) const

inherited

Returns the library with this layer

Returns: Library for this layer

Definition at line 254 of file layerconfiguration.cc.

◆ getNEMId()

EMANE::NEMId EMANE::NEMConfiguration::getNEMId ( )

Gets this nem's id

Returns: Id of this nem

Definition at line 68 of file nemconfiguration.cc.

◆ getType()

std::string EMANE::LayerConfiguration::getType ( ) const

inherited

Returns the type with this layer

Returns: Type for this layer

Definition at line 247 of file layerconfiguration.cc.

◆ isExternalTransport()

bool EMANE::NEMConfiguration::isExternalTransport ( )

Returns whether-or-not this NEM transport is external

Returns: True if external, false otherwise

Definition at line 82 of file nemconfiguration.cc.

◆ isValid()

bool EMANE::NEMConfiguration::isValid ( )

Returns whether-or-not this NEM is 'valid'

Returns: True if this NEM is valid, false otherwise

Definition at line 89 of file nemconfiguration.cc.

◆ overlayParams()

void EMANE::LayerConfiguration::overlayParams ( xmlNodePtr pNode )

inherited

Overlay parent parameter values atop child values already parsed

Parameters

pNode Pointer to parent node of params to overlay

Definition at line 214 of file layerconfiguration.cc.

◆ processDefinition()

void EMANE::LayerConfiguration::processDefinition	(	const char *	pxzName,
		const std::string &	sURI
	)

protectedinherited

Processes the definition of a given layer

Parameters

pxzName	Name of the xml node to expect as root
sURI	The URI to parse

Exceptions

ParseException

ValidateException

Definition at line 51 of file layerconfiguration.cc.

◆ setPathAndFile()

void EMANE::LayerConfiguration::setPathAndFile ( const std::string sURI )

protectedinherited

Identify URL & URN portion of the definition file

Definition at line 275 of file layerconfiguration.cc.

Member Data Documentation

◆ params_

ParamMap EMANE::LayerConfiguration::params_

protectedinherited

Internal map { paramname, [ paramvals ] }

Definition at line 214 of file layerconfiguration.h.

◆ sLibrary_

std::string EMANE::LayerConfiguration::sLibrary_

protectedinherited

Name of implementing library

Definition at line 209 of file layerconfiguration.h.

◆ sName_

std::string EMANE::LayerConfiguration::sName_

protectedinherited

Configured name of this layer

Definition at line 204 of file layerconfiguration.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ NEMType

Constructor & Destructor Documentation

◆ NEMConfiguration()

◆ ~NEMConfiguration()

Member Function Documentation

◆ doProcessChildNode()

◆ doProcessChildren()

◆ doProcessParam()

◆ doProcessParamlist()

◆ doProcessRootAttributes()

◆ getAttrVal()

◆ getAttrValNumeric()

◆ getConfigurationUpdateRequest()

◆ getDefinitionFile()

◆ getDefinitionPath()

◆ getLayers()

◆ getLibrary()

◆ getNEMId()

◆ getType()

◆ isExternalTransport()

◆ isValid()

◆ overlayParams()

◆ processDefinition()

◆ setPathAndFile()

Member Data Documentation

◆ params_

◆ sLibrary_

◆ sName_