class URBANopt::Scenario::ScenarioRunnerBase

Public Class Methods

new() click to toggle source

ScenarioRunnerBase is the agnostic interface for a class which can create and run SimulationFiles.

# File lib/urbanopt/scenario/scenario_runner_base.rb, line 12
def initialize; end

Public Instance Methods

create_simulation_files(scenario, force_clear = false) click to toggle source

Create all SimulationDirs for Scenario.

parameters:

  • scenario - ScenarioBase - Scenario to create simulation input files for scenario.

  • force_clear - Bool - Clear Scenario before creating simulation input files

return:

Array Returns an array of all SimulationDirs, even those created previously, for Scenario.

# File lib/urbanopt/scenario/scenario_runner_base.rb, line 22
def create_simulation_files(scenario, force_clear = false)
  raise 'create_input_files is not implemented for ScenarioRunnerBase, override in your class'
end
run(scenario, force_clear = false, options = {}) click to toggle source

Create and run all SimulationFiles for Scenario.

parameters:

  • scenario - ScenarioBase - Scenario to create and run simulation input files for.

  • force_clear - Bool - Clear Scenario before creating Simulation input files.

return:

Array Returns an array of all SimulationDirs, even those created previously, for Scenario.

# File lib/urbanopt/scenario/scenario_runner_base.rb, line 34
def run(scenario, force_clear = false, options = {})
  raise 'run is not implemented for ScenarioRunnerBase, override in your class'
end