cohydra.scenario

The blueprint for a simulation.

Classes

Scenario

The scenario is kind of a blueprint for a simulation.

class cohydra.scenario.Scenario

Bases: object

The scenario is kind of a blueprint for a simulation.

A scenario can be used the following way:

Example

scenario = Scenario()
...
with scenario as simulation:
    simulation.simulate(simulation_time=60)

networks = None

All networks belonging to the scenario.

workflows = None

The workflows to be executed.

simulation = None

A reference to a simulation (if running).

visualization = None

The visualization object

context = None

The Context is e.g.used for teardowns.

It is created on simulation start.

add_network(network)

Add a network to be simulated.

Parameters

network (Network) – The Network to add. It will get prepared on simulation start.

add_mobility_input(mobility_input)

Add a MobilityInput.

Parameters

mobility_input (MobilityInput) – The MobilityInput to add. It will get prepared on simulation start.

set_visualization(visualization)

Sets the new Visualization.

Parameters

visualization (Visualization) – The new visualization object.

channels()

Retrieve all channels.

Returns

All channels of all networks in the current configuration.

Return type

list of Channel

nodes()

Retrieve all nodes

Returns

All nodes of all channels in the current configuration.

Return type

list of Node

workflow(func)

Add a workflow to the scenario.

Parameters

func (callable) – The callable to be executed.

Inheritance Diagramm