EMANE  1.2.1
Public Member Functions | Protected Member Functions | List of all members
EMANE::Generators::EEL::LoaderPlugin Class Referenceabstract

Interface used to create an EEL loader plugin implementation. More...

#include <loaderplugin.h>

Inheritance diagram for EMANE::Generators::EEL::LoaderPlugin:
EMANE::Generators::EEL::LoaderAntennaProfile EMANE::Generators::EEL::LoaderCommEffect EMANE::Generators::EEL::LoaderFadingSelection EMANE::Generators::EEL::LoaderLocation EMANE::Generators::EEL::LoaderPathloss

Public Member Functions

virtual ~LoaderPlugin ()
 
virtual void load (const ModuleType &moduleType, const ModuleId &moduleId, const EventType &eventType, const InputArguments &args)=0
 
virtual EventInfoList getEvents (EventPublishMode mode)=0
 

Protected Member Functions

 LoaderPlugin ()
 

Detailed Description

Interface used to create an EEL loader plugin implementation.

Definition at line 51 of file loaderplugin.h.

Constructor & Destructor Documentation

◆ ~LoaderPlugin()

virtual EMANE::Generators::EEL::LoaderPlugin::~LoaderPlugin ( )
inlinevirtual

Destroys an instance

Definition at line 57 of file loaderplugin.h.

◆ LoaderPlugin()

EMANE::Generators::EEL::LoaderPlugin::LoaderPlugin ( )
inlineprotected

Definition at line 85 of file loaderplugin.h.

Member Function Documentation

◆ getEvents()

virtual EventInfoList EMANE::Generators::EEL::LoaderPlugin::getEvents ( EventPublishMode  mode)
pure virtual

Gets the events to publish

Parameters
modePublish either the complete current known list of events or just those items that have changed
Returns
event information to publish

Implemented in EMANE::Generators::EEL::LoaderLocation, EMANE::Generators::EEL::LoaderAntennaProfile, EMANE::Generators::EEL::LoaderCommEffect, EMANE::Generators::EEL::LoaderFadingSelection, and EMANE::Generators::EEL::LoaderPathloss.

◆ load()

virtual void EMANE::Generators::EEL::LoaderPlugin::load ( const ModuleType &  moduleType,
const ModuleId &  moduleId,
const EventType &  eventType,
const InputArguments &  args 
)
pure virtual

Loads an EEL expression

Parameters
moduleTypeModule type
moduleIdModule id
eventTypeThe event type
argsThe event arguments
Exceptions
FormatExceptionwhen a module load fails

Implemented in EMANE::Generators::EEL::LoaderLocation, EMANE::Generators::EEL::LoaderAntennaProfile, EMANE::Generators::EEL::LoaderCommEffect, EMANE::Generators::EEL::LoaderFadingSelection, and EMANE::Generators::EEL::LoaderPathloss.

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