ScenarioManager

Package: inet.common.scenario

ScenarioManager

simple module

ScenarioManager is for setting up and controlling simulation experiments. You can schedule certain events to take place at specified times, like changing a parameter value, changing the bit error rate of a connection, removing or adding connections, removing or adding routes in a routing table, etc, so that you can observe the transient behaviour.

ScenarioManager executes a script specified in XML. It has a few built-in commands, while other commands are dispatched to be carried out by given simple modules. (The C++ class of these simple modules' needs to implement the IScriptable interface, and the processCommand() method must be redefined accordingly).

An example script:

<scenario>
    <set-param t="10" module="host[1].mobility" par="speed" value="5"/>
    <set-param t="20" module="host[1].mobility" par="speed" expr="20+10"/>
    <set-param t="30" module="host[1].mobility" par="displayStringTextFormat" value='p: %p\nv: %v'/>
    <set-param t="30" module="host[1].mobility" par="displayStringTextFormat" expr='"p: %p\nv: %v"'/>
    <at t="50">
        <set-param module="host[2].mobility" par="speed" value="10"/>
        <set-param module="host[3].mobility" par="speed" value="10"/>
        <connect src-module="host[2]" src-gate="ppp[0]"
                 dest-module="host[1]" dest-gate="ppp[0]"
                 channel-type="ned.DatarateChannel">
            <param name="datarate" value="10Mbps" />
            <param name="delay" value="0.1us" />
        </connect>
    </at>
    <at t="60">
        <disconnect src-module="host[2]" src-gate="ppp[0]" />
    </at>
    <at t="2s">
        <initiate module="Router2" operation="shutdown"/>
        <shutdown module="Router2"/>
        <start module="Router2"/>
        <crash module="Router2"/>
    </at>
</scenario>

Built-in commands: <at>, <set-param>, <set-channel-param>, <create-module>, <delete-module>, <connect>, <disconnect>, <initiate>, <startup>, <shutdown>, <crash>

All commands have a t attribute which carries the simulation time at which the command has to be carried out. You can group several commands to be carried out at the same simulation time using <at>, and then only the <at> command is needed to have a t attribute.

Supported attributes:

  • <set-param>: module, par, value|expr. module: path to module (required) par: name of settable parameter of module (required) value: new value for parameter expr: expression for calculate new value of parameter Note: value and expr are exclusive, required one
  • <set-channel-param>: src-module, src-gate|dest-module, par, value|expr. src-module: path to source module (required) src-gate: name of source gate dest-module: path to destination module par: name of settable parameter of module (required) value: new value for parameter expr: expression for calculate new value of parameter Note: src-gate and dest-module are exclusive, required one; value and expr are exclusive, required one; if dest-module is present, there must be exactly one connection between src-module and dest-module (which may be bidirectional); if src-gate references an inout gate, the parameter will be set on the channel of both directions.
  • <connect>: src-module, src-gate, dest-module, dest-gate, channel-type src-module: path to source module (required) src-gate: name of source gate (required) dest-module: path to destination module (required) dest-gate: name of destination gate (required) channel-type: full qualified ned type of connection channel (required), e.g. "ned.DatarateChannel"
    • <param>: name, value|expr name: name of settable parameter of channel (required) value: new value for parameter expr: expression for calculate new value of parameter Note: value and expr are exclusive, required one
  • <disconnect>: src-module, src-gate|dest-module src-module: path to source module (required) src-gate: name of source gate dest-module: path to destination module Note: src-gate and dest-module are exclusive, required one; if dest-module is present, there must be exactly one connection between src-module and dest-module (which may be bidirectional); if src-gate references an inout gate, both directions will be disconnected.
  • <create-module>: parent, submodule, type, vector parent: parent module path (required) submodule: name of created module (required) type: NED type of created module (required), e.g. "inet.applications.pingapp.PingApp" vector: boolean, if true, the module created as vector element with next index, if false, the module created as a single module, if missing, detects existing vector by submodule name
  • <delete-module>: module module: path to module (required)
ScenarioManager

Parameters

Name Type Default value Description
script xml xml("")

Properties

Name Value Description
display i=block/control
labels node

Scheduled messages (observed)

msgkindctrltagsmsgnamecontext
ScenarioTimer0scenario-event

Direct method calls (observed)

call tofunctioninfo
DhcpClientinet::DhcpClient::handleOperationStagehandleOperationStage
DhcpServerinet::DhcpServer::handleOperationStagehandleOperationStage
PingAppinet::PingApp::handleOperationStagehandleOperationStage
TelnetAppinet::TelnetApp::handleOperationStagehandleOperationStage
UdpBasicAppinet::UdpBasicApp::handleOperationStagehandleOperationStage
UdpBasicBurstinet::UdpBasicBurst::handleOperationStagehandleOperationStage
UdpVideoStreamClientinet::UdpVideoStreamClient::handleOperationStagehandleOperationStage
SettableClockinet::SettableClock::processCommandprocessCommand
NodeStatusinet::NodeStatus::handleOperationStagehandleOperationStage
AckingMacinet::AckingMac::handleOperationStagehandleOperationStage
AckingWirelessInterfaceinet::NetworkInterface::handleOperationStagehandleOperationStage
L2NodeConfiguratorinet::L2NodeConfigurator::handleOperationStagehandleOperationStage
EthernetInterfaceinet::NetworkInterface::handleOperationStagehandleOperationStage
EthernetInterfaceinet::NetworkInterface::receiveSignalPOST_MODEL_CHANGE
LayeredEthernetInterfaceinet::NetworkInterface::handleOperationStagehandleOperationStage
LayeredEthernetInterfaceinet::NetworkInterface::receiveSignalPOST_MODEL_CHANGE
EthernetCsmaMacinet::EthernetCsmaMac::receiveSignalPOST_MODEL_CHANGE
EthernetEncapsulationinet::EthernetEncapsulation::handleOperationStagehandleOperationStage
EthernetMacinet::EthernetMac::handleOperationStagehandleOperationStage
EthernetMacinet::EthernetMac::receiveSignalPOST_MODEL_CHANGE
MacForwardingTableinet::MacForwardingTable::handleOperationStagehandleOperationStage
Ieee80211Interfaceinet::NetworkInterface::handleOperationStagehandleOperationStage
Ieee80211Interfaceinet::NetworkInterface::receiveSignalPOST_MODEL_CHANGE
Ieee80211LlcLpdinet::ieee80211::Ieee80211LlcLpd::handleOperationStagehandleOperationStage
Ieee80211Macinet::ieee80211::Ieee80211Mac::handleOperationStagehandleOperationStage
Ieee80211MgmtAdhocinet::ieee80211::Ieee80211MgmtAdhoc::handleOperationStagehandleOperationStage
Ieee8021dRelayinet::Ieee8021dRelay::handleOperationStagehandleOperationStage
Rstpinet::Rstp::handleOperationStagehandleOperationStage
Stpinet::Stp::handleOperationStagehandleOperationStage
Ieee8022Llcinet::Ieee8022Llc::handleOperationStagehandleOperationStage
Loopbackinet::Loopback::handleOperationStagehandleOperationStage
LoopbackInterfaceinet::NetworkInterface::handleOperationStagehandleOperationStage
LoopbackInterfaceinet::NetworkInterface::receiveSignalPOST_MODEL_CHANGE
Pppinet::Ppp::handleOperationStagehandleOperationStage
Pppinet::Ppp::receiveSignalPOST_MODEL_CHANGE
Pppinet::Ppp::receiveSignalPRE_MODEL_CHANGE
PppInterfaceinet::NetworkInterface::handleOperationStagehandleOperationStage
PppInterfaceinet::NetworkInterface::receiveSignalPOST_MODEL_CHANGE
Arpinet::Arp::handleOperationStagehandleOperationStage
GlobalArpinet::GlobalArp::handleOperationStagehandleOperationStage
InterfaceTableinet::InterfaceTable::handleOperationStagehandleOperationStage
Ipv4NodeConfiguratorinet::Ipv4NodeConfigurator::handleOperationStagehandleOperationStage
Ipv4inet::Ipv4::handleOperationStagehandleOperationStage
Ipv4RoutingTableinet::Ipv4RoutingTable::handleOperationStagehandleOperationStage
Ldpinet::Ldp::handleOperationStagehandleOperationStage
NextHopForwardinginet::NextHopForwarding::handleOperationStagehandleOperationStage
RsvpTeinet::RsvpTe::addSessionaddSession
RsvpTeinet::RsvpTe::delSessiondelSession
RsvpTeinet::RsvpTe::handleOperationStagehandleOperationStage
Tedinet::Ted::handleOperationStagehandleOperationStage
EthernetHubinet::physicallayer::WireJunction::receiveSignalPOST_MODEL_CHANGE
WireJunctioninet::physicallayer::WireJunction::receiveSignalPOST_MODEL_CHANGE
Ieee80211ScalarRadioinet::physicallayer::Ieee80211Radio::handleOperationStagehandleOperationStage
UnitDiskRadioinet::physicallayer::UnitDiskRadio::handleOperationStagehandleOperationStage
PacketReceiverinet::PacketReceiver::handleOperationStagehandleOperationStage
PacketTransmitterinet::PacketTransmitter::handleOperationStagehandleOperationStage
Aodvinet::aodv::Aodv::handleOperationStagehandleOperationStage
Dsdvinet::Dsdv::handleOperationStagehandleOperationStage
Dymoinet::dymo::Dymo::handleOperationStagehandleOperationStage
Gpsrinet::Gpsr::handleOperationStagehandleOperationStage
Ospfv2inet::ospfv2::Ospfv2::handleOperationStagehandleOperationStage
Ripinet::Rip::handleOperationStagehandleOperationStage
Tcpinet::tcp::Tcp::handleOperationStagehandleOperationStage
Udpinet::Udp::handleOperationStagehandleOperationStage

Called methods (observed)

functioninfocall from
inet::ScenarioManager::moduleOperationStageCompletedmoduleOperationStageCompletedDhcpClient, DhcpServer, PingApp, TelnetApp, UdpBasicApp, UdpBasicBurst, UdpVideoStreamClient, EthernetMac, Ldp, Rip, Tcp

Tagging operations (observed)

tagTypetagAction
inet::Ipv4InterfaceDatafindTag

Source code

//
// ~ScenarioManager is for setting up and controlling simulation experiments.
// You can schedule certain events to take place at specified times,
// like changing a parameter value, changing the bit error rate of
// a connection, removing or adding connections, removing or
// adding routes in a routing table, etc, so that you can observe the
// transient behaviour.
//
// ~ScenarioManager executes a script specified in XML. It has a few
// built-in commands, while other commands are dispatched to be carried out
// by given simple modules. (The C++ class of these simple modules' needs
// to implement the ~IScriptable interface, and the processCommand() method
// must be redefined accordingly).
//
// An example script:
//
// <pre>
// <scenario>
//     <set-param t="10" module="host[1].mobility" par="speed" value="5"/>
//     <set-param t="20" module="host[1].mobility" par="speed" expr="20+10"/>
//     <set-param t="30" module="host[1].mobility" par="displayStringTextFormat" value='p: %p\nv: %v'/>
//     <set-param t="30" module="host[1].mobility" par="displayStringTextFormat" expr='"p: %p\nv: %v"'/>
//     <at t="50">
//         <set-param module="host[2].mobility" par="speed" value="10"/>
//         <set-param module="host[3].mobility" par="speed" value="10"/>
//         <connect src-module="host[2]" src-gate="ppp[0]"
//                  dest-module="host[1]" dest-gate="ppp[0]"
//                  channel-type="ned.DatarateChannel">
//             <param name="datarate" value="10Mbps" />
//             <param name="delay" value="0.1us" />
//         </connect>
//     </at>
//     <at t="60">
//         <disconnect src-module="host[2]" src-gate="ppp[0]" />
//     </at>
//     <at t="2s">
//         <initiate module="Router2" operation="shutdown"/>
//         <shutdown module="Router2"/>
//         <start module="Router2"/>
//         <crash module="Router2"/>
//     </at>
// </scenario>
// </pre>
//
// Built-in commands: <at>, <set-param>, <set-channel-param>,
// <create-module>, <delete-module>, <connect>, <disconnect>,
// <initiate>, <startup>, <shutdown>, <crash>
//
// All commands have a t attribute which carries the simulation time
// at which the command has to be carried out. You can group several commands
// to be carried out at the same simulation time using <at>, and
// then only the <at> command is needed to have a t attribute.
//
// Supported attributes:
// - <set-param>: module, par, value|expr.
//       module: path to module (required)
//       par: name of settable parameter of module (required)
//       value: new value for parameter
//       expr: expression for calculate new value of parameter
//       Note: value and expr are exclusive, required one
// - <set-channel-param>: src-module, src-gate|dest-module, par, value|expr.
//       src-module: path to source module (required)
//       src-gate: name of source gate
//       dest-module: path to destination module
//       par: name of settable parameter of module (required)
//       value: new value for parameter
//       expr: expression for calculate new value of parameter
//       Note: src-gate and dest-module are exclusive, required one;
//             value and expr are exclusive, required one;
//             if dest-module is present, there must be exactly one connection
//             between src-module and dest-module (which may be bidirectional);
//             if src-gate references an inout gate, the parameter will be set
//             on the channel of both directions.
// - <connect>: src-module, src-gate, dest-module, dest-gate, channel-type
//       src-module: path to source module (required)
//       src-gate: name of source gate (required)
//       dest-module: path to destination module (required)
//       dest-gate: name of destination gate (required)
//       channel-type: full qualified ned type of connection channel (required), e.g. "ned.DatarateChannel"
//     - <param>: name, value|expr
//       name: name of settable parameter of channel (required)
//       value: new value for parameter
//       expr: expression for calculate new value of parameter
//       Note: value and expr are exclusive, required one
// - <disconnect>: src-module, src-gate|dest-module
//       src-module: path to source module (required)
//       src-gate: name of source gate
//       dest-module: path to destination module
//       Note: src-gate and dest-module are exclusive, required one;
//       if dest-module is present, there must be exactly one connection
//       between src-module and dest-module (which may be bidirectional);
//       if src-gate references an inout gate, both directions will be disconnected.
// - <create-module>: parent, submodule, type, vector
//       parent: parent module path (required)
//       submodule: name of created module (required)
//       type: NED type of created module (required), e.g. "inet.applications.pingapp.PingApp"
//       vector: boolean, if true, the module created as vector element with next index,
//               if false, the module created as a single module,
//               if missing, detects existing vector by submodule name
// - <delete-module>: module
//       module: path to module (required)
//
simple ScenarioManager
{
    parameters:
        xml script = default(xml("<script></script>"));
        @display("i=block/control");
        @labels(node,mpls-node);
}
File: src/inet/common/scenario/ScenarioManager.ned

This documentation is released under the Creative Commons license