class URBANopt::Scenario::Extension

Public Class Methods

new() click to toggle source

Calls superclass method

# File lib/urbanopt/scenario/extension.rb, line 11
def initialize
  super
  @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
end

Public Instance Methods

doc_templates_dir() click to toggle source

Doc templates are common files like copyright files which are used to update measures and other code. Doc templates will only be applied to measures in the current repository.

return:: Absolute path of the doc templates dir or nil if there is none.

# File lib/urbanopt/scenario/extension.rb, line 35
def doc_templates_dir
  return File.absolute_path(File.join(@root_dir, 'doc_templates'))
end

files_dir() click to toggle source

Relevant files such as weather data, design days, etc.

return:: Absolute path of the files or nil if there is none, used when configuring OSWs

# File lib/urbanopt/scenario/extension.rb, line 26
def files_dir
  return nil
end

measures_dir() click to toggle source

return:: Absolute path of the measures or nil if there is none, can be used when configuring OSWs.

# File lib/urbanopt/scenario/extension.rb, line 18
def measures_dir
  return File.absolute_path(File.join(@root_dir, 'lib', 'measures'))
end