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

This operation represents the process of orderly stopping down a module. More...

#include <ModuleOperations.h>

Inheritance diagram for inet::ModuleStopOperation:
inet::LifecycleOperation

Public Types

enum  Stage {
  STAGE_LOCAL, STAGE_APPLICATION_LAYER, STAGE_ROUTING_PROTOCOLS, STAGE_TRANSPORT_LAYER,
  STAGE_NETWORK_LAYER, STAGE_LINK_LAYER, STAGE_PHYSICAL_LAYER, STAGE_LAST
}
 
- Public Types inherited from inet::LifecycleOperation
typedef std::map< std::string, std::string > StringMap
 

Public Member Functions

virtual int getNumStages () const override
 Returns the number of stages required by this operation. More...
 
- Public Member Functions inherited from inet::LifecycleOperation
 LifecycleOperation ()
 
virtual void initialize (cModule *module, StringMap &params)
 Initialize the operation using the parameters provided in the string map. More...
 
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

This operation represents the process of orderly stopping down a module.

Operation stages are organized top-down similarly to the OSI network layers.

Member Enumeration Documentation

◆ Stage

Enumerator
STAGE_LOCAL 
STAGE_APPLICATION_LAYER 
STAGE_ROUTING_PROTOCOLS 
STAGE_TRANSPORT_LAYER 
STAGE_NETWORK_LAYER 
STAGE_LINK_LAYER 
STAGE_PHYSICAL_LAYER 
STAGE_LAST 
48  {
49  STAGE_LOCAL, // for changes that don't depend on other modules
56  STAGE_LAST // for changes that others shouldn't depend on
57  };

Member Function Documentation

◆ getNumStages()

virtual int inet::ModuleStopOperation::getNumStages ( ) const
inlineoverridevirtual

Returns the number of stages required by this operation.

Implements inet::LifecycleOperation.

60 { return STAGE_LAST + 1; }

The documentation for this class was generated from the following file:
inet::ModuleStopOperation::STAGE_NETWORK_LAYER
@ STAGE_NETWORK_LAYER
Definition: ModuleOperations.h:53
inet::ModuleStopOperation::STAGE_LAST
@ STAGE_LAST
Definition: ModuleOperations.h:56
inet::ModuleStopOperation::STAGE_TRANSPORT_LAYER
@ STAGE_TRANSPORT_LAYER
Definition: ModuleOperations.h:52
inet::ModuleStopOperation::STAGE_LOCAL
@ STAGE_LOCAL
Definition: ModuleOperations.h:49
inet::ModuleStopOperation::STAGE_PHYSICAL_LAYER
@ STAGE_PHYSICAL_LAYER
Definition: ModuleOperations.h:55
inet::ModuleStopOperation::STAGE_LINK_LAYER
@ STAGE_LINK_LAYER
Definition: ModuleOperations.h:54
inet::ModuleStopOperation::STAGE_ROUTING_PROTOCOLS
@ STAGE_ROUTING_PROTOCOLS
Definition: ModuleOperations.h:51
inet::ModuleStopOperation::STAGE_APPLICATION_LAYER
@ STAGE_APPLICATION_LAYER
Definition: ModuleOperations.h:50