Class: URBANopt::Scenario::ScenarioPostProcessorBase

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

Direct Known Subclasses

ScenarioDefaultPostProcessor

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scenario_base) ⇒ ScenarioPostProcessorBase

ScenarioPostProcessorBase post-processes a Scenario to create scenario level results.

parameters:

  • scenario_base - ScenarioBase - An object of ScenarioBase class.



14
15
16
 
# File 'lib/urbanopt/scenario/scenario_post_processor_base.rb', line 14

def initialize(scenario_base)
  @scenario_base = scenario_base
end

Instance Attribute Details

#scenario_base ⇒ Object (readonly)

Returns the value of attribute scenario_base.



18
19
20
 
# File 'lib/urbanopt/scenario/scenario_post_processor_base.rb', line 18

def scenario_base
  @scenario_base
end

Instance Method Details

#add_simulation_dir(simulation_dir) ⇒ Object

Add results from a simulation_dir to this result.

parameters:

  • simulation_dir - SimulationDirOSW - An object on SimulationDirOSW class.



32
33
34
 
# 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 ⇒ Object

Run the post processor on this Scenario.



23
24
25
 
# 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 ⇒ Object

Save scenario result.



39
40
41
 
# File 'lib/urbanopt/scenario/scenario_post_processor_base.rb', line 39

def save
  raise 'save not implemented for ScenarioPostProcessorBase, override in your class'
end