lib/measures/from_honeybee_model/measure.rb in honeybee-openstudio-1.8.1 vs lib/measures/from_honeybee_model/measure.rb in honeybee-openstudio-1.8.2
- old
+ new
@@ -1,91 +1,91 @@
-# *******************************************************************************
-# 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.
-# *******************************************************************************
-
-# see the URL below for information on how to write OpenStudio measures
-# http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
-
-require 'from_honeybee/model'
-
-# start the measure
-class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
- # human readable name
- def name
- return 'From Honeybee Model'
- end
-
- # human readable description
- def description
- return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
- end
-
- # human readable description of modeling approach
- def modeler_description
- return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
- end
-
- # define the arguments that the user will input
- def arguments(model)
- args = OpenStudio::Measure::OSArgumentVector.new
-
- # Make an argument for the honyebee model json
- model_json = OpenStudio::Measure::OSArgument.makeStringArgument('model_json', true)
- model_json.setDisplayName('Path to the Honeybee Model JSON file')
- args << model_json
-
- return args
- end
-
- # define what happens when the measure is run
- def run(model, runner, user_arguments)
- super(model, runner, user_arguments)
- STDOUT.flush
- if !runner.validateUserArguments(arguments(model), user_arguments)
- return false
- end
-
- model_json = runner.getStringArgumentValue('model_json', user_arguments)
-
- if !File.exist?(model_json)
- runner.registerError("Cannot find file '#{model_json}'")
- return false
- end
-
- honeybee_model = FromHoneybee::Model.read_from_disk(model_json)
-
- STDOUT.flush
- honeybee_model.to_openstudio_model(model)
- STDOUT.flush
- return true
- end
-end
-
-# register the measure to be used by the application
-FromHoneybeeModel.new.registerWithApplication
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+# see the URL below for information on how to write OpenStudio measures
+# http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
+
+require 'from_honeybee/model'
+
+# start the measure
+class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
+ # human readable name
+ def name
+ return 'From Honeybee Model'
+ end
+
+ # human readable description
+ def description
+ return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
+ end
+
+ # human readable description of modeling approach
+ def modeler_description
+ return 'Translate a JSON file of a Honeybee Model into an OpenStudio Model.'
+ end
+
+ # define the arguments that the user will input
+ def arguments(model)
+ args = OpenStudio::Measure::OSArgumentVector.new
+
+ # Make an argument for the honyebee model json
+ model_json = OpenStudio::Measure::OSArgument.makeStringArgument('model_json', true)
+ model_json.setDisplayName('Path to the Honeybee Model JSON file')
+ args << model_json
+
+ return args
+ end
+
+ # define what happens when the measure is run
+ def run(model, runner, user_arguments)
+ super(model, runner, user_arguments)
+ STDOUT.flush
+ if !runner.validateUserArguments(arguments(model), user_arguments)
+ return false
+ end
+
+ model_json = runner.getStringArgumentValue('model_json', user_arguments)
+
+ if !File.exist?(model_json)
+ runner.registerError("Cannot find file '#{model_json}'")
+ return false
+ end
+
+ honeybee_model = FromHoneybee::Model.read_from_disk(model_json)
+
+ STDOUT.flush
+ honeybee_model.to_openstudio_model(model)
+ STDOUT.flush
+ return true
+ end
+end
+
+# register the measure to be used by the application
+FromHoneybeeModel.new.registerWithApplication