EMANE::NEMLayer Class Reference

Base class for NEMLayer containers. Builders construct NEMLayer objects to contain derived instances of NEMLayer objects and track them through the system. Model implementors should derive from one of the layer implementor classes, not this class. More...

#include <nemlayer.h>

Inheritance diagram for EMANE::NEMLayer:

Public Member Functions
virtual	~NEMLayer ()
NEMId	getNEMId () 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 ()
virtual void	processUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs=empty)=0
virtual void	processUpstreamControl (const ControlMessages &msgs)=0
virtual void	setDownstreamTransport (DownstreamTransport *pDownstreamTransport)
void	sendDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs=empty)
void	sendDownstreamControl (const ControlMessages &msgs)
virtual void	processDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs=empty)=0
virtual void	processDownstreamControl (const ControlMessages &msgs)=0
virtual void	setUpstreamTransport (UpstreamTransport *pUpstreamTransport)
void	sendUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs=empty)
void	sendUpstreamControl (const ControlMessages &msgs)
virtual void	processEvent (const EventId &eventId, const Serialization &serialization)
virtual void	processTimedEvent (TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg)
BuildId	getBuildId () const
void	setBuildId (BuildId bid)
virtual void	processConfiguration (const ConfigurationUpdate &update)

Static Public Attributes
static const ControlMessages	empty
static const ControlMessages	empty

Protected Member Functions
	NEMLayer (NEMId id, PlatformServiceProvider *p)

Protected Attributes
NEMId	id_
PlatformServiceProvider *	pPlatformService_

Detailed Description

Base class for NEMLayer containers. Builders construct NEMLayer objects to contain derived instances of NEMLayer objects and track them through the system. Model implementors should derive from one of the layer implementor classes, not this class.

See also

MACLayerImplementor, PHYLayerImplementor, ShimLayerImplementor

Definition at line 57 of file nemlayer.h.

Constructor & Destructor Documentation

~NEMLayer()

virtual EMANE::NEMLayer::~NEMLayer ( )

inlinevirtual

Definition at line 65 of file nemlayer.h.

NEMLayer()

EMANE::NEMLayer::NEMLayer ( NEMId  id, PlatformServiceProvider *  p  )

inlineprotected

Definition at line 75 of file nemlayer.h.

Member Function Documentation

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.

getNEMId()

NEMId EMANE::NEMLayer::getNEMId ( ) const

inline

Get the NEM identifier.

Returns

NEM identifier

Definition at line 72 of file nemlayer.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.

processConfiguration()

virtual void EMANE::RunningStateMutable::processConfiguration ( const ConfigurationUpdate &  update )

inlinevirtualinherited

Process dynamic running-state configuration updates

Parameters

update

Configuration update

Note

Running state configuration errors are indicated using a validator. Validators can be registered using the ConfigurationRegistrar.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::TDMA::BaseModel, EMANE::NEMStatefulLayer, EMANE::NEMQueuedLayer, and EMANE::FrameworkPHY.

Definition at line 63 of file runningstatemutable.h.

processDownstreamControl()

virtual void EMANE::DownstreamTransport::processDownstreamControl ( const ControlMessages &  msgs )

pure virtualinherited

Process downstream control message

Parameters

msgs	Reference to the ControlMessages

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::NEMStatefulLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::FrameworkPHY, EMANE::Models::Bypass::PHYLayer, EMANE::Models::TDMA::BaseModel, EMANE::Models::PHYAPITest::ShimLayer, EMANE::NEMQueuedLayer, EMANE::Application::TransportAdapterImpl, EMANE::Models::CommEffect::Shim, and EMANE::Models::TimingAnalysis::ShimLayer.

processDownstreamPacket()

virtual void EMANE::DownstreamTransport::processDownstreamPacket ( DownstreamPacket &  pkt, const ControlMessages &  msgs = empty  )

pure virtualinherited

Process downstream packet

Parameters

pkt	Reference to the DownstreamPacket to process
msgs	optional reference to the ControlMessages

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::NEMStatefulLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::FrameworkPHY, EMANE::Models::Bypass::PHYLayer, EMANE::Models::TDMA::BaseModel, EMANE::Models::PHYAPITest::ShimLayer, EMANE::NEMOTAAdapter, EMANE::NEMQueuedLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, and EMANE::Application::TransportAdapterImpl.

processEvent()

virtual void EMANE::EventServiceUser::processEvent ( const EventId &  eventId, const Serialization &  serialization  )

inlinevirtualinherited

Process an event.

Parameters

eventId	event identifier corresponding to the serialized event
serialization	opaque event object data

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::NEMStatefulLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::Bypass::MACLayer, EMANE::FrameworkPHY, EMANE::Models::TDMA::BaseModel, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TDMA::EventScheduler, and EMANE::Agents::GPSDLocation::Agent.

Definition at line 58 of file eventserviceuser.h.

processTimedEvent()

virtual void EMANE::TimerServiceUser::processTimedEvent ( TimerEventId  eventId, const TimePoint &  expireTime, const TimePoint &  scheduleTime, const TimePoint &  fireTime, const void *  arg  )

inlinevirtualinherited

Process a timed event

Parameters

eventId	Identifier corresponding to the timer being processed
expireTime	The time the timer was scheduled to expire
scheduleTime	The Time the timer was scheduled
fireTime	Time time The time the timer actually fired
arg	Opaque timed event data

Note

All times are abosulte using CLOCK_REALTIME

Reimplemented in EMANE::NEMStatefulLayer, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Agents::GPSDLocation::Agent, EMANE::TimerServiceProxy, and EMANE::NEMTimerServiceProxy.

Definition at line 62 of file timerserviceuser.h.

processUpstreamControl()

virtual void EMANE::UpstreamTransport::processUpstreamControl ( const ControlMessages &  msgs )

pure virtualinherited

Process upstream control message

Parameters

msgs	reference to the ControlMessages

Implemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::NEMStatefulLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Models::Bypass::MACLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::TDMA::BaseModel, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, and EMANE::NEMNetworkAdapter.

processUpstreamPacket()

virtual void EMANE::UpstreamTransport::processUpstreamPacket ( UpstreamPacket &  pkt, const ControlMessages &  msgs = empty  )

pure virtualinherited

Process upstream packet

Parameters

pkt	reference to the UpstreamPacket to process
msgs	optional reference to the ControlMessages

Implemented in EMANE::NEMStatefulLayer, EMANE::Transports::Virtual::VirtualTransport, EMANE::NEMQueuedLayer, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Transports::Raw::RawTransport, EMANE::Models::CommEffect::Shim, EMANE::Models::TimingAnalysis::ShimLayer, and EMANE::NEMNetworkAdapter.

sendDownstreamControl()

void EMANE::UpstreamTransport::sendDownstreamControl ( const ControlMessages &  msgs )

inlineinherited

Send downstream control message

Parameters

msgs	reference to the ControlMessages

Definition at line 44 of file upstreamtransport.inl.

sendDownstreamPacket()

void EMANE::UpstreamTransport::sendDownstreamPacket ( DownstreamPacket &  pkt, const ControlMessages &  msgs = empty  )

inlineinherited

Send downsteam packet

Parameters

pkt	reference to the DownstreamPacket to process
msgs	optional reference to the ControlMessages

Definition at line 37 of file upstreamtransport.inl.

sendUpstreamControl()

void EMANE::DownstreamTransport::sendUpstreamControl ( const ControlMessages &  msgs )

inlineinherited

Send upstream control message

Parameters

msgs	Reference to the ControlMessages

Definition at line 44 of file downstreamtransport.inl.

sendUpstreamPacket()

void EMANE::DownstreamTransport::sendUpstreamPacket ( UpstreamPacket &  pkt, const ControlMessages &  msgs = empty  )

inlineinherited

Send upstream packet

Parameters

pkt	Reference to the UpstreamPacket to process
msgs	optional reference to the ControlMessages

Definition at line 37 of file downstreamtransport.inl.

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.

setDownstreamTransport()

virtual void EMANE::UpstreamTransport::setDownstreamTransport ( DownstreamTransport *  pDownstreamTransport )

inlinevirtualinherited

Set the downstream transport.

Parameters

pDownstreamTransport

Pointer to the downstream transport of this upstream transport.

Note

: This method is for internal framework use only.

Reimplemented in EMANE::NEMStatefulLayer, EMANE::PHYLayer, EMANE::MACLayer, EMANE::ShimLayer, and EMANE::TransportLayer.

Definition at line 82 of file upstreamtransport.h.

setUpstreamTransport()

virtual void EMANE::DownstreamTransport::setUpstreamTransport ( UpstreamTransport *  pUpstreamTransport )

inlinevirtualinherited

Set the upstream transport.

Parameters

pUpstreamTransport

Pointer to the upstream transport of this downstream transport.

Reimplemented in EMANE::NEMStatefulLayer, EMANE::MACLayer, EMANE::ShimLayer, EMANE::PHYLayer, and EMANE::TransportLayer.

Definition at line 79 of file downstreamtransport.h.

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

empty [1/2]

const EMANE::ControlMessages EMANE::DownstreamTransport::empty

staticinherited

Definition at line 102 of file downstreamtransport.h.

empty [2/2]

const EMANE::ControlMessages EMANE::UpstreamTransport::empty

staticinherited

Definition at line 106 of file upstreamtransport.h.

id_

NEMId EMANE::NEMLayer::id_

protected

Definition at line 81 of file nemlayer.h.

pPlatformService_

PlatformServiceProvider* EMANE::PlatformServiceUser::pPlatformService_

protectedinherited

Definition at line 64 of file platformserviceuser.h.

---

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

• nemlayer.h