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" value="30"/>
    <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]" />
        <disconnect src-module="host[1]" 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.
    • <set-channel-param>: src-module, src-gate, par, value.
    • <connect>: src-module, src-gate, dest-module, dest-gate, channel-type
      • <param>: name, value
    • <disconnect>: src-module, src-gate note: if src-gate names an inout gate, both directions will be disconnected.
    • <create-module>: parent, submodule, type, vector parent: parent path submodule: name of created module type: type of created module 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
ScenarioManager

Parameters

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

Properties

Name Value Description
display i=block/control
labels node

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" value="30"/>
//     <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]" />
//         <disconnect src-module="host[1]" 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.
//    - <set-channel-param>: src-module, src-gate, par, value.
//    - <connect>: src-module, src-gate, dest-module, dest-gate, channel-type
//        - <param>: name, value
//    - <disconnect>: src-module, src-gate
//          note: if src-gate names an inout gate, both directions will be disconnected.
//    - <create-module>: parent, submodule, type, vector
//          parent: parent path
//          submodule: name of created module
//          type: type of created module
//          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
//
simple ScenarioManager
{
    parameters:
        xml script = default(xml("<script></script>"));
        @display("i=block/control");
        @labels(node,mpls-node);
}


File: src/inet/common/scenario/ScenarioManager.ned