EMANE  1.2.1
EMANE::Generators::EEL::Generator Class Reference

#include <eeleventgenerator.h>

Inheritance diagram for EMANE::Generators::EEL::Generator:
EMANE::EventGenerator EMANE::Component EMANE::PlatformServiceUser EMANE::Buildable EMANE::EventServiceUser EMANE::TimerServiceUser

Public Member Functions

 Generator (PlatformServiceProvider *pPlatformService)
 
 ~Generator ()
 
void initialize (Registrar &registrar) override
 
void configure (const ConfigurationUpdate &update) override
 
void start () override
 
void stop () override
 
void destroy () override throw ()
 
virtual void postStart ()
 
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)
 

Protected Attributes

PlatformServiceProviderpPlatformService_
 

Detailed Description

Definition at line 55 of file eeleventgenerator.h.

Constructor & Destructor Documentation

◆ Generator()

EMANE::Generators::EEL::Generator::Generator ( PlatformServiceProvider pPlatformService)

Definition at line 47 of file eeleventgenerator.cc.

◆ ~Generator()

EMANE::Generators::EEL::Generator::~Generator ( )

Definition at line 52 of file eeleventgenerator.cc.

Member Function Documentation

◆ configure()

void EMANE::Generators::EEL::Generator::configure ( const ConfigurationUpdate update)
overridevirtual

Configure the component.

Parameters
updateConfiguration update values
Exceptions
ConfigureExceptionthrown when a unexpected configuration item is encountered or there is a problem with the specified item value

Implements EMANE::Component.

Definition at line 73 of file eeleventgenerator.cc.

◆ destroy()

void EMANE::Generators::EEL::Generator::destroy ( )
throw (
)
overridevirtual

Destroy the component.

Implements EMANE::Component.

Definition at line 215 of file eeleventgenerator.cc.

◆ 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.

◆ initialize()

void EMANE::Generators::EEL::Generator::initialize ( Registrar registrar)
overridevirtual

Initialize the component.

Exceptions
InitializeExceptionthrown when an error is encountered during initialization

Implements EMANE::Component.

Definition at line 54 of file eeleventgenerator.cc.

◆ postStart()

◆ processEvent()

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

◆ 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
eventIdIdentifier corresponding to the timer being processed
expireTimeThe time the timer was scheduled to expire
scheduleTimeThe Time the timer was scheduled
fireTimeTime time The time the timer actually fired
argOpaque 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.

◆ 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
bidthe BuildId
Note
: This method is for internal framework use only.

Definition at line 40 of file buildable.inl.

◆ start()

void EMANE::Generators::EEL::Generator::start ( )
overridevirtual

Start the component.

Exceptions
StartExceptionthrown when an error is encountered during start.

Implements EMANE::Component.

Definition at line 198 of file eeleventgenerator.cc.

◆ stop()

void EMANE::Generators::EEL::Generator::stop ( )
overridevirtual

Stop the component.

Exceptions
StopExceptionthrown when an error is encountered during stop

Implements EMANE::Component.

Definition at line 203 of file eeleventgenerator.cc.

Member Data Documentation

◆ pPlatformService_

PlatformServiceProvider* EMANE::PlatformServiceUser::pPlatformService_
protectedinherited

Definition at line 64 of file platformserviceuser.h.


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