INET Framework for OMNeT++/OMNEST
inet::IScriptable Class Referenceabstract

Modules that need to be scriptable by ScenarioManager should "implement" (subclass from) this class. More...

#include <IScriptable.h>

Inheritance diagram for inet::IScriptable:
inet::LifecycleController inet::NetworkInfo inet::RSVP inet::SimpleClassifier

Public Member Functions

virtual ~IScriptable ()
 
virtual void processCommand (const cXMLElement &node)=0
 Called by ScenarioManager whenever a script command needs to be carried out by the module. More...
 

Detailed Description

Modules that need to be scriptable by ScenarioManager should "implement" (subclass from) this class.

See also
ScenarioManager
Author
Andras Varga

Constructor & Destructor Documentation

virtual inet::IScriptable::~IScriptable ( )
inlinevirtual
35 {}

Member Function Documentation

virtual void inet::IScriptable::processCommand ( const cXMLElement &  node)
pure virtual

Called by ScenarioManager whenever a script command needs to be carried out by the module.

The command is represented by the XML element or element tree. The command name can be obtained as:

const char *command = node->getTagName()

Parameters are XML attributes, e.g. a "neighbour" parameter can be retrieved as:

const char *attr = node->getAttribute("neighbour")

More complex input can be passed in child elements.

See also
cXMLElement

Implemented in inet::RSVP, inet::LifecycleController, inet::SimpleClassifier, and inet::NetworkInfo.

Referenced by inet::ScenarioManager::processModuleSpecificCommand().


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