WSModelObject > WSRun

A hydraulic run, which can be generated from an instance of WSRunScheduler.

Methods:

• release
• run
• run_control_id
• run_control_id= (Set)
• run_network_id
• run_network_id= (Set)
• run_scenario_ids
• run_scenario_ids= (Set)

release

#release ⇒ void

EXCHANGE

Releases (removes) the run from the queue, this is optional and can be called after the run has finished.

run

#run ⇒ void

EXCHANGE, UI

Performs the run.

This method will block the current thread, meaning that the script will halt until the run has completed. An alternative method for performing runs asynchonously is the WSRunScheduler.wsma method.

run_control_id

#run_control_id ⇒ Integer?

EXCHANGE, UI

Returns the current control model ID.

run_control_id= (Set)

#run_control_id=(id) ⇒ void

EXCHANGE, UI

Sets the control model ID, if the run is not read-only.

Parameters

run_network_id

#run_network_id ⇒ Integer?

EXCHANGE, UI

Returns the current network model ID.

run_network_id= (Set)

#run_network_id=(id) ⇒ void

EXCHANGE, UI

Sets the network model ID, if the run is not read-only.

Parameters

run_scenario_ids

#run_scenario_ids { ... } ⇒ String

EXCHANGE, UI

Returns the current scenario names.

Example

run.run_scenario_ids { |scenario| puts scenario}

run_scenario_ids= (Set)

#run_scenario_ids=(scenarios) ⇒ void

EXCHANGE, UI

Sets the scenarios used in the run, if the run is not read-only.

Parameters