Class: URBANopt::Scenario::ScenarioRunnerBase

Inherits:
Object
  • Object
show all
Defined in:
lib/urbanopt/scenario/scenario_runner_base.rb

Direct Known Subclasses

ScenarioRunnerOSW

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ScenarioRunnerBase

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



47
 
# File 'lib/urbanopt/scenario/scenario_runner_base.rb', line 47

def initialize; end

Instance Method Details

#create_simulation_files(scenario, force_clear = false) ⇒ Object

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.



57
58
59
 
# File 'lib/urbanopt/scenario/scenario_runner_base.rb', line 57

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 = {}) ⇒ Object

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.



69
70
71
 
# File 'lib/urbanopt/scenario/scenario_runner_base.rb', line 69

def run(scenario, force_clear = false, options = {})
  raise 'run is not implemented for ScenarioRunnerBase, override in your class'
end