INET Framework for OMNeT++/OMNEST
inet::ApplicationOperationBase Class Reference

Base class for lifecycle operations that manipulate a application. More...

#include <ApplicationOperations.h>

Inheritance diagram for inet::ApplicationOperationBase:
inet::LifecycleOperation inet::ApplicationStartOperation inet::ApplicationStopOperation

Public Types

enum  Stage { STAGE_LOCAL, STAGE_LAST }
 
- Public Types inherited from inet::LifecycleOperation
typedef std::map< std::string, std::string > StringMap
 

Public Member Functions

 ApplicationOperationBase ()
 
virtual void initialize (cModule *module, StringMap &params)
 Initialize the operation using the parameters provided in the string map. More...
 
virtual int getNumStages () const
 Returns the number of stages required by this operation. More...
 
- Public Member Functions inherited from inet::LifecycleOperation
 LifecycleOperation ()
 
cModule * getRootModule () const
 Returns the module the operation is initiated on. More...
 
int getCurrentStage () const
 Returns the current stage, an integer in 0..numStages-1. More...
 

Detailed Description

Base class for lifecycle operations that manipulate a application.

Member Enumeration Documentation

◆ Stage

Enumerator
STAGE_LOCAL 
STAGE_LAST 

Constructor & Destructor Documentation

◆ ApplicationOperationBase()

inet::ApplicationOperationBase::ApplicationOperationBase ( )
inline
24 {}

Member Function Documentation

◆ getNumStages()

virtual int inet::ApplicationOperationBase::getNumStages ( ) const
inlinevirtual

Returns the number of stages required by this operation.

Implements inet::LifecycleOperation.

26 { return STAGE_LAST + 1; }

◆ initialize()

void inet::ApplicationOperationBase::initialize ( cModule *  module,
StringMap params 
)
virtual

Initialize the operation using the parameters provided in the string map.

The implementation should destructively modify the map, removing from it the parameters it understands. Ideally, the map should be empty when this method returns; if it is not, the caller should treat that as an error, and report the remaining parameters as unrecognized by the operation.

Reimplemented from inet::LifecycleOperation.

16 {
17  LifecycleOperation::initialize(module, params);
18 }

The documentation for this class was generated from the following files:
inet::ApplicationOperationBase::STAGE_LAST
@ STAGE_LAST
Definition: ApplicationOperations.h:21
inet::ApplicationOperationBase::STAGE_LOCAL
@ STAGE_LOCAL
Definition: ApplicationOperations.h:21
inet::LifecycleOperation::initialize
virtual void initialize(cModule *module, StringMap &params)
Initialize the operation using the parameters provided in the string map.
Definition: LifecycleOperation.h:49