class URBANopt::Scenario::SimulationDirBase

Public Class Methods

new(scenario, features, feature_names) click to toggle source

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.

# 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

Public Instance Methods

clear() click to toggle source

Clear the directory that this simulation runs in

# 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() click to toggle source

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

# 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?() click to toggle source

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

# 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() click to toggle source

Return the directory that this simulation will run in

# 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() click to toggle source

Returns simulation status one of {'Not Started', 'Started', 'Complete', 'Failed'}

# 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