# *********************************************************************************
# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
# contributors. All rights reserved.

# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:

# Redistributions of source code must retain the above copyright notice, this list
# of conditions and the following disclaimer.

# Redistributions in binary form must reproduce the above copyright notice, this
# list of conditions and the following disclaimer in the documentation and/or other
# materials provided with the distribution.

# Neither the name of the copyright holder nor the names of its contributors may be
# used to endorse or promote products derived from this software without specific
# prior written permission.

# Redistribution of this software, without modification, must refer to the software
# by the same designation. Redistribution of a modified version of this software
# (i) may not refer to the modified version by the same designation, or by any
# confusingly similar designation, and (ii) must refer to the underlying software
# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
# the term “URBANopt”, or any confusingly similar designation may not be used to
# refer to any modified version of this software or any modified version of the
# underlying software originally provided by Alliance without the prior written
# consent of Alliance.

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
# OF THE POSSIBILITY OF SUCH DAMAGE.
# *********************************************************************************

require 'urbanopt/reporting'
require 'openstudio/common_measures'
require 'openstudio/model_articulation'
require 'openstudio/load_flexibility_measures'

require_relative 'HighEfficiency'

require 'json'

module URBANopt
  module Scenario
    class ThermalStorageMapper < HighEfficiencyMapper
      def create_osw(scenario, features, feature_names)
        osw = super(scenario, features, feature_names)

        # Add ice to applicable TES object building and set applicable charge and discharge times

        if feature_names[0].to_s == 'Mixed_use 1'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_central_ice_storage', '__SKIP__', false)
          OpenStudio::Extension.set_measure_argument(osw, 'add_central_ice_storage', 'storage_capacity', 6000)
        end

        if feature_names[0].to_s == 'Restaurant 1'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_packaged_ice_storage', '__SKIP__', false)
        end

        if feature_names[0].to_s == 'Restaurant 10'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_packaged_ice_storage', '__SKIP__', false)
        end

        if feature_names[0].to_s == 'Restaurant 12'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_packaged_ice_storage', '__SKIP__', false)
        end

        if feature_names[0].to_s == 'Restaurant 14'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_packaged_ice_storage', '__SKIP__', false)
        end

        if feature_names[0].to_s == 'Restaurant 15'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_packaged_ice_storage', '__SKIP__', false)
        end

        if feature_names[0].to_s == 'Office 1'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_central_ice_storage', '__SKIP__', false)
          OpenStudio::Extension.set_measure_argument(osw, 'add_central_ice_storage', 'storage_capacity', 1200)
        end

        if feature_names[0].to_s == 'Hospital 1'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_central_ice_storage', '__SKIP__', false)
          OpenStudio::Extension.set_measure_argument(osw, 'add_central_ice_storage', 'storage_capacity', 3000)
        end

        if feature_names[0].to_s == 'Hospital 2'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_central_ice_storage', '__SKIP__', false)
          OpenStudio::Extension.set_measure_argument(osw, 'add_central_ice_storage', 'storage_capacity', 900)
        end

        if feature_names[0].to_s == 'Mixed use 2'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_central_ice_storage', '__SKIP__', false)
          OpenStudio::Extension.set_measure_argument(osw, 'add_central_ice_storage', 'storage_capacity', 7000)
        end

        if feature_names[0].to_s == 'Restaurant 13'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_packaged_ice_storage', '__SKIP__', false)
        end

        if feature_names[0].to_s == 'Mall 1'
          OpenStudio::Extension.set_measure_argument(osw,
                                                     'add_central_ice_storage', '__SKIP__', false)
          OpenStudio::Extension.set_measure_argument(osw, 'add_central_ice_storage', 'storage_capacity', 1500)
        end

        if feature_names[0].to_s == 'Hotel 1'
          # PTAC coils must be explicitly excluded
          ptac_coils = ['BUILDING STORY 10 THERMALZONE PTAC 1SPD DX AC CLG COIL 458KBTU/HR 9.5EER',
                        'BUILDING STORY 4 THERMALZONE PTAC 1SPD DX AC CLG COIL 369KBTU/HR 9.5EER',
                        'BUILDING STORY 5 THERMALZONE PTAC 1SPD DX AC CLG COIL 370KBTU/HR 9.5EER',
                        'BUILDING STORY 6 THERMALZONE PTAC 1SPD DX AC CLG COIL 370KBTU/HR 9.5EER',
                        'BUILDING STORY 7 THERMALZONE PTAC 1SPD DX AC CLG COIL 370KBTU/HR 9.5EER',
                        'BUILDING STORY 8 THERMALZONE PTAC 1SPD DX AC CLG COIL 370KBTU/HR 9.5EER',
                        'BUILDING STORY 9 THERMALZONE PTAC 1SPD DX AC CLG COIL 371KBTU/HR 9.5EER']

          ptac_coils.each do |ptac|
            OpenStudio::Extension.set_measure_argument(osw, 'add_packaged_ice_storage', ptac, false)
          end
        end

        return osw
      end
    end
  end
end