honeybee-openstudio 0 → 1.8.1

data/lib/{to_openstudio → from_honeybee}/load/people.rb

@@ -1,91 +1,100 @@
-# *******************************************************************************
-# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
-# Energy, LLC, Ladybug Tools 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:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) 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.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, 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 'honeybee/load/people'
-
-require 'to_openstudio/model_object'
-
-module Honeybee
-  class PeopleAbridged
-
-    def find_existing_openstudio_object(openstudio_model)
-      model_people = openstudio_model.getPeopleDefinitionByName(@hash[:identifier])
-      return model_people.get unless model_people.empty?
-      nil
-    end
-
-    def to_openstudio(openstudio_model)
-
-      # create people OpenStudio object and set identifier
-      os_people_def = OpenStudio::Model::PeopleDefinition.new(openstudio_model)
-      os_people = OpenStudio::Model::People.new(os_people_def)
-      os_people_def.setName(@hash[:identifier])
-      os_people.setName(@hash[:identifier])
-
-      # assign people per space floor area
-      os_people_def.setPeopleperSpaceFloorArea(@hash[:people_per_area])
-
-      # assign activity schedule
-      activity_sch = openstudio_model.getScheduleByName(@hash[:activity_schedule])
-      unless activity_sch.empty?
-        activity_sch_object = activity_sch.get
-        os_people.setActivityLevelSchedule(activity_sch_object)
-      end
-
-      # assign occupancy schedule
-      occupancy_sch = openstudio_model.getScheduleByName(@hash[:occupancy_schedule])
-      unless occupancy_sch.empty?
-        occupancy_sch_object = occupancy_sch.get
-        os_people.setNumberofPeopleSchedule(occupancy_sch_object)
-      end
-
-      # assign radiant fraction if it exists
-      if @hash[:radiant_fraction]
-        os_people_def.setFractionRadiant(@hash[:radiant_fraction])
-      else
-        os_people_def.setFractionRadiant(defaults[:radiant_fraction][:default])
-      end
-
-      # assign latent fraction if it exists
-      if @hash[:latent_fraction]
-        if @hash[:latent_fraction].is_a? Numeric
-          sensible_fraction = 1 - (@hash[:latent_fraction])
-          os_people_def.setSensibleHeatFraction(sensible_fraction)
-        else
-          os_people_def.autocalculateSensibleHeatFraction()
-        end
-      end
-
-      os_people
-    end
-
-  end #PeopleAbridged
-end #Honeybee
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable 
+# Energy, LLC, Ladybug Tools 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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 'from_honeybee/extension'
+require 'from_honeybee/model_object'
+
+module FromHoneybee
+  class PeopleAbridged < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+      raise "Incorrect model type '#{@type}'" unless @type == 'PeopleAbridged'
+    end
+  
+    def defaults
+      @@schema[:components][:schemas][:PeopleAbridged][:properties]
+    end
+  
+    def find_existing_openstudio_object(openstudio_model)
+      model_people = openstudio_model.getPeopleDefinitionByName(@hash[:identifier])
+      return model_people.get unless model_people.empty?
+      nil
+    end
+  
+    def to_openstudio(openstudio_model)
+
+      # create people OpenStudio object and set identifier
+      os_people_def = OpenStudio::Model::PeopleDefinition.new(openstudio_model)
+      os_people = OpenStudio::Model::People.new(os_people_def)
+      os_people_def.setName(@hash[:identifier])
+      os_people.setName(@hash[:identifier])
+
+      # assign people per space floor area
+      os_people_def.setPeopleperSpaceFloorArea(@hash[:people_per_area])
+
+      # assign activity schedule
+      activity_sch = openstudio_model.getScheduleByName(@hash[:activity_schedule])
+      unless activity_sch.empty?
+        activity_sch_object = activity_sch.get
+        os_people.setActivityLevelSchedule(activity_sch_object)
+      end
+
+      # assign occupancy schedule
+      occupancy_sch = openstudio_model.getScheduleByName(@hash[:occupancy_schedule])
+      unless occupancy_sch.empty?
+        occupancy_sch_object = occupancy_sch.get
+        os_people.setNumberofPeopleSchedule(occupancy_sch_object)
+      end
+
+      # assign radiant fraction if it exists
+      if @hash[:radiant_fraction]
+        os_people_def.setFractionRadiant(@hash[:radiant_fraction])
+      else
+        os_people_def.setFractionRadiant(defaults[:radiant_fraction][:default])
+      end
+
+      # assign latent fraction if it exists
+      if @hash[:latent_fraction]
+        if @hash[:latent_fraction].is_a? Numeric
+          sensible_fraction = 1 - (@hash[:latent_fraction])
+          os_people_def.setSensibleHeatFraction(sensible_fraction)
+        else
+          os_people_def.autocalculateSensibleHeatFraction()
+        end
+      end
+
+      os_people
+    end
+
+  end #PeopleAbridged
+end #FromHoneybee

data/lib/{to_openstudio → from_honeybee}/load/setpoint_humidistat.rb

@@ -1,66 +1,75 @@
-# *******************************************************************************
-# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
-# Energy, LLC, Ladybug Tools 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:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) 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.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, 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 'honeybee/load/setpoint_humidistat'
-
-require 'to_openstudio/model_object'
-
-module Honeybee
-  class SetpointHumidistat
-
-    def to_openstudio(openstudio_model)
-
-      # create humidistat openstudio object
-      os_humidistat = OpenStudio::Model::ZoneControlHumidistat.new(openstudio_model)
-
-      # assign humidifying schedule if it exists
-      if @hash[:humidifying_schedule]
-        humid_sch = openstudio_model.getScheduleByName(@hash[:humidifying_schedule])
-        unless humid_sch.empty?
-          humid_sch_object = humid_sch.get
-          os_humidistat.setHumidifyingRelativeHumiditySetpointSchedule(humid_sch_object)
-        end
-      end
-
-      # assign dehumidifying schedule if it exists
-      if @hash[:dehumidifying_schedule]
-        dehumid_sch = openstudio_model.getScheduleByName(@hash[:dehumidifying_schedule])
-        unless dehumid_sch.empty?
-          dehumid_sch_object = dehumid_sch.get
-          os_humidistat.setDehumidifyingRelativeHumiditySetpointSchedule(dehumid_sch_object)
-        end
-      end
-
-      os_humidistat
-    end
-
-  end #SetpointHumidistat
-end #Honeybee
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable 
+# Energy, LLC, Ladybug Tools 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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 'from_honeybee/extension'
+require 'from_honeybee/model_object'
+
+module FromHoneybee
+  class SetpointHumidistat < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+      raise "Incorrect model type '#{@type}'" unless @type == 'SetpointAbridged'
+    end
+  
+    def defaults
+      @@schema[:components][:schemas][:SetpointAbridged][:properties]
+    end
+      
+    def to_openstudio(openstudio_model)
+
+      # create humidistat openstudio object
+      os_humidistat = OpenStudio::Model::ZoneControlHumidistat.new(openstudio_model)
+
+      # assign humidifying schedule if it exists
+      if @hash[:humidifying_schedule]
+        humid_sch = openstudio_model.getScheduleByName(@hash[:humidifying_schedule])
+        unless humid_sch.empty?
+          humid_sch_object = humid_sch.get
+          os_humidistat.setHumidifyingRelativeHumiditySetpointSchedule(humid_sch_object)
+        end
+      end
+
+      # assign dehumidifying schedule if it exists
+      if @hash[:dehumidifying_schedule]
+        dehumid_sch = openstudio_model.getScheduleByName(@hash[:dehumidifying_schedule])
+        unless dehumid_sch.empty?
+          dehumid_sch_object = dehumid_sch.get
+          os_humidistat.setDehumidifyingRelativeHumiditySetpointSchedule(dehumid_sch_object)
+        end
+      end
+
+      os_humidistat
+    end
+
+  end #SetpointHumidistat
+end #FromHoneybee

data/lib/{to_openstudio → from_honeybee}/load/setpoint_thermostat.rb

@@ -1,62 +1,71 @@
-# *******************************************************************************
-# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
-# Energy, LLC, Ladybug Tools 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:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) 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.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, 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 'honeybee/load/setpoint_thermostat'
-
-require 'to_openstudio/model_object'
-
-module Honeybee
-  class SetpointThermostat < ModelObject
-
-    def to_openstudio(openstudio_model)
-
-      # create thermostat openstudio object
-      os_thermostat = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(openstudio_model)
-
-      # assign heating setpoint temperature schedule
-      heat_sch = openstudio_model.getScheduleByName(@hash[:heating_schedule])
-      unless heat_sch.empty?
-        heat_sch_object = heat_sch.get
-        os_thermostat.setHeatingSetpointTemperatureSchedule(heat_sch_object)
-      end
-
-      # assign cooling setpoint schedule
-      cool_sch = openstudio_model.getScheduleByName(@hash[:cooling_schedule])
-      unless cool_sch.empty?
-        cool_sch_object = cool_sch.get
-        os_thermostat.setCoolingSetpointTemperatureSchedule(cool_sch_object)
-      end
-
-      os_thermostat
-    end
-
-  end #SetpointThermostat
-end #Honeybee
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable 
+# Energy, LLC, Ladybug Tools 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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 'from_honeybee/extension'
+require 'from_honeybee/model_object'
+
+module FromHoneybee
+  class SetpointThermostat < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+      raise "Incorrect model type '#{@type}'" unless @type == 'SetpointAbridged'
+    end
+  
+    def defaults
+      @@schema[:components][:schemas][:SetpointAbridged][:properties]
+    end
+  
+    def to_openstudio(openstudio_model)
+
+      # create thermostat openstudio object
+      os_thermostat = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(openstudio_model)
+
+      # assign heating setpoint temperature schedule
+      heat_sch = openstudio_model.getScheduleByName(@hash[:heating_schedule])
+      unless heat_sch.empty?
+        heat_sch_object = heat_sch.get
+        os_thermostat.setHeatingSetpointTemperatureSchedule(heat_sch_object)
+      end
+      
+      # assign cooling setpoint schedule
+      cool_sch = openstudio_model.getScheduleByName(@hash[:cooling_schedule])
+      unless cool_sch.empty?
+        cool_sch_object = cool_sch.get
+        os_thermostat.setCoolingSetpointTemperatureSchedule(cool_sch_object)
+      end
+
+      os_thermostat
+    end
+
+  end #SetpointThermostat
+end #FromHoneybee