class URBANopt::Scenario::ScenarioPostProcessorBase
Attributes
scenario_base[R]
Public Class Methods
new(scenario_base)
click to toggle source
ScenarioPostProcessorBase
post-processes a Scenario
to create scenario level results.
- parameters:
-
scenario_base
- ScenarioBase - An object ofScenarioBase
class.
# File lib/urbanopt/scenario/scenario_post_processor_base.rb, line 14 def initialize(scenario_base) @scenario_base = scenario_base end
Public Instance Methods
add_simulation_dir(simulation_dir)
click to toggle source
Add results from a simulation_dir to this result.
- parameters:
-
simulation_dir
- SimulationDirOSW - An object onSimulationDirOSW
class.
# File lib/urbanopt/scenario/scenario_post_processor_base.rb, line 32 def add_simulation_dir(simulation_dir) raise 'add_simulation_dir not implemented for ScenarioPostProcessorBase, override in your class' end
run()
click to toggle source
Run the post processor on this Scenario
.
# File lib/urbanopt/scenario/scenario_post_processor_base.rb, line 23 def run raise 'run not implemented for ScenarioPostProcessorBase, override in your class' end
save()
click to toggle source
Save scenario result.
# File lib/urbanopt/scenario/scenario_post_processor_base.rb, line 39 def save raise 'save not implemented for ScenarioPostProcessorBase, override in your class' end