Class: URBANopt::Scenario::SimulationDirBase

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

Direct Known Subclasses

SimulationDirOSW

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scenario, features, feature_names) ⇒ SimulationDirBase

SimulationDirBase is the agnostic representation of a directory of simulation input files.

parameters:

  • scenario - ScenarioBase - Scenario containing this SimulationDirBase.

  • features - Array - Array of Features that this SimulationDirBase represents.

  • feature_names - Array - Array of scenario specific names for these Features.



16
17
18
19
20
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 16

def initialize(scenario, features, feature_names)
  @scenario = scenario
  @features = features
  @feature_names = feature_names
end

Instance Attribute Details

#feature_names ⇒ Object (readonly)

:nodoc: #:nodoc: #:nodoc:



22
23
24
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 22

def feature_names
  @feature_names
end

#features ⇒ Object (readonly)

:nodoc: #:nodoc: #:nodoc:



22
23
24
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 22

def features
  @features
end

#scenario ⇒ Object (readonly)

:nodoc: #:nodoc: #:nodoc:



22
23
24
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 22

def scenario
  @scenario
end

Instance Method Details

#clear ⇒ Object

Clear the directory that this simulation runs in



49
50
51
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 49

def clear
  raise 'clear is not implemented for SimulationFileBase, override in your class'
end

#create_input_files ⇒ Object

Create run directory and generate simulation inputs, all previous contents of directory are removed



56
57
58
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 56

def create_input_files
  raise 'create_input_files is not implemented for SimulationFileBase, override in your class'
end

#out_of_date? ⇒ Boolean

Return true if the simulation is out of date (input files newer than results), false otherwise. Non-existent simulation input files are out of date.

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 35

def out_of_date?
  raise 'out_of_date? is not implemented for SimulationFileBase, override in your class'
end

#run_dir ⇒ Object

Return the directory that this simulation will run in



27
28
29
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 27

def run_dir
  raise 'run_dir is not implemented for SimulationFileBase, override in your class'
end

#simulation_status ⇒ Object

Returns simulation status one of Started’, ‘Started’, ‘Complete’, ‘Failed’



42
43
44
 
# File 'lib/urbanopt/scenario/simulation_dir_base.rb', line 42

def simulation_status
  raise 'simulation_status is not implemented for SimulationFileBase, override in your class'
end