Contents

# *********************************************************************************
# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
# See also https://github.com/urbanopt/urbanopt-reporting-gem/blob/develop/LICENSE.md
# *********************************************************************************

require 'urbanopt/reporting/version'
require 'openstudio/extension'

module URBANopt
  module Reporting
    class Extension < OpenStudio::Extension::Extension
      def initialize # :nodoc:
        @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
      end

      ##
      # Returns the absolute path of the measures or returns nil, in case no measures are
      # added. It can be used while configuring OSWs.
      def measures_dir
        return File.absolute_path(File.join(@root_dir, 'lib/measures'))
      end

      ##
      # The directory containign relevant files such as weather data, design days, etc.
      # The method returns nil if no files are present. It is used while configuring OSWs.
      def files_dir
        return nil
      end

      # The directory containing common files like copyright and license notices which are used to update measures and other code.
      # This method will only be applied to measures in the current repository and
      # returns the absolute path of the +doc_templates_dir+ or nil if there is none.
      def doc_templates_dir
        return File.absolute_path(File.join(@root_dir, 'doc_templates'))
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
urbanopt-reporting-0.10.1	lib/urbanopt/reporting/derived_extension.rb
urbanopt-reporting-0.10.0	lib/urbanopt/reporting/derived_extension.rb
urbanopt-reporting-0.9.1	lib/urbanopt/reporting/derived_extension.rb
urbanopt-reporting-0.9.0	lib/urbanopt/reporting/derived_extension.rb
urbanopt-reporting-0.8.0	lib/urbanopt/reporting/derived_extension.rb