Class: URBANopt::Core::Extension

Inherits:
OpenStudio::Extension::Extension
  • Object
show all
Defined in:
lib/urbanopt/core/extension.rb

Instance Method Summary collapse

Constructor Details

#initializeExtension

include OpenStudio::Extension def initialize; end



14
15
16
# File 'lib/urbanopt/core/extension.rb', line 14

def initialize
  @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
end

Instance Method Details

#doc_templates_dirObject

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 the absolute path of the doc templates dir or nil if there is none



32
33
34
# File 'lib/urbanopt/core/extension.rb', line 32

def doc_templates_dir
  return File.absolute_path(File.join(@root_dir, 'doc_templates'))
end

#files_dirObject

Relevant files such as weather data, design days, etc. Return the absolute path of the files or nil if there is none, used when configuring OSWs



25
26
27
# File 'lib/urbanopt/core/extension.rb', line 25

def files_dir
  return nil
end

#measures_dirObject

Return the absolute path of the measures or nil if there is none, can be used when configuring OSWs



19
20
21
# File 'lib/urbanopt/core/extension.rb', line 19

def measures_dir
  return File.absolute_path(File.join(@root_dir, 'lib/measures/'))
end