openstudio-common-measures 0.9.0 → 0.10.0

data/lib/measures/tariff_selection_flat/measure.rb

@@ -6,10 +6,6 @@
 # see the URL below for information on how to write OpenStudio measures
 # http://nrel.github.io/OpenStudio-user-documentation/measures/measure_writing_guide/
 
-# load OpenStudio measure libraries from openstudio-extension gem
-require 'openstudio-extension'
-require 'openstudio/extension/core/os_lib_helper_methods'
-
 # start the measure
 class TariffSelectionFlat < OpenStudio::Measure::EnergyPlusMeasure
   # human readable name
@@ -108,7 +104,9 @@ class TariffSelectionFlat < OpenStudio::Measure::EnergyPlusMeasure
     super(workspace, runner, user_arguments)
 
     # assign the user inputs to variables
-    args = OsLib_HelperMethods.createRunVariables(runner, workspace, user_arguments, arguments(workspace))
+    args = runner.getArgumentValues(arguments(workspace), user_arguments)
+    args = Hash[args.collect{ |k, v| [k.to_s, v] }]
+    
     if !args then return false end
 
     # reporting initial condition of model

data/lib/measures/tariff_selection_flat/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>tariff_selection_flat</name>
   <uid>539c3e8e-6c41-4f50-ac61-6cbbf1ee1b55</uid>
-  <version_id>1fb9337b-b3e4-4ac8-a75d-57682714b063</version_id>
-  <version_modified>20221115T223610Z</version_modified>
+  <version_id>30111c72-9467-4d48-92e9-084c1c3ebe44</version_id>
+  <version_modified>2024-07-11T14:32:14Z</version_modified>
   <xml_checksum>FBDC6D11</xml_checksum>
   <class_name>TariffSelectionFlat</class_name>
   <display_name>Tariff Selection-Flat</display_name>
@@ -210,16 +210,10 @@
   </attributes>
   <files>
     <file>
-      <filename>EnvelopeAndLoadTestModel_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>E11F67BD</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>BFFB1AA6</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -228,27 +222,33 @@
       <checksum>A6339B0D</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
-    </file>
-    <file>
-      <filename>tariff_selection_flat_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>9104949F</checksum>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
     </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
         <identifier>2.0.0</identifier>
-        <min_compatible>2.8.0</min_compatible>
+        <min_compatible>3.8.0</min_compatible>
       </version>
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>0B3FD5BD</checksum>
+      <checksum>AE5AA325</checksum>
+    </file>
+    <file>
+      <filename>EnvelopeAndLoadTestModel_01.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>E11F67BD</checksum>
+    </file>
+    <file>
+      <filename>tariff_selection_flat_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>7DEEBDDA</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/tariff_selection_generic/measure.rb

@@ -6,10 +6,6 @@
 # see the URL below for information on how to write OpenStuido measures
 # http://openstudio.nrel.gov/openstudio-measure-writing-guide
 
-# load OpenStudio measure libraries from openstudio-extension gem
-require 'openstudio-extension'
-require 'openstudio/extension/core/os_lib_helper_methods'
-
 # start the measure
 class TariffSelectionGeneric < OpenStudio::Measure::EnergyPlusMeasure
   # define the name that a user will see, this method may be deprecated as
@@ -98,7 +94,8 @@ class TariffSelectionGeneric < OpenStudio::Measure::EnergyPlusMeasure
   def run(workspace, runner, user_arguments)
     super(workspace, runner, user_arguments)
 
-    args = OsLib_HelperMethods.createRunVariables(runner, workspace, user_arguments, arguments(workspace))
+    args = runner.getArgumentValues(arguments(workspace), user_arguments)
+    args = Hash[args.collect{ |k, v| [k.to_s, v] }]
     if !args then return false end
 
     # reporting initial condition of model

data/lib/measures/tariff_selection_generic/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>tariff_selection_generic</name>
   <uid>d65ae535-f0ea-4745-9f5b-8d42c7070741</uid>
-  <version_id>9c549927-8229-4938-a80c-c006dd6f0f35</version_id>
-  <version_modified>20221115T223609Z</version_modified>
+  <version_id>63aaf453-3f25-42e9-a02b-67b47b9664f2</version_id>
+  <version_modified>2024-07-11T14:32:13Z</version_modified>
   <xml_checksum>43564105</xml_checksum>
   <class_name>TariffSelectionGeneric</class_name>
   <display_name> Tariff Selection-Generic</display_name>
@@ -126,16 +126,33 @@
   </attributes>
   <files>
     <file>
-      <filename>EnvelopeAndLoadTestModel_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>E11F67BD</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>BFFB1AA6</checksum>
     </file>
     <file>
-      <filename>Example_E.idf</filename>
-      <filetype>idf</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>98AC420A</checksum>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>27EC34FF</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>3.8.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>04E8B27F</checksum>
     </file>
     <file>
       <filename>Example_A.idf</filename>
@@ -161,6 +178,12 @@
       <usage_type>resource</usage_type>
       <checksum>DA5EBB8B</checksum>
     </file>
+    <file>
+      <filename>Example_E.idf</filename>
+      <filetype>idf</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>98AC420A</checksum>
+    </file>
     <file>
       <filename>Example_F.idf</filename>
       <filetype>idf</filetype>
@@ -179,12 +202,6 @@
       <usage_type>resource</usage_type>
       <checksum>1F984D08</checksum>
     </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
-    </file>
     <file>
       <filename>FlatEnergyCharge-Gas.idf</filename>
       <filetype>idf</filetype>
@@ -198,33 +215,16 @@
       <checksum>8DAD6C69</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>27EC34FF</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
+      <filename>EnvelopeAndLoadTestModel_01.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>E11F67BD</checksum>
     </file>
     <file>
       <filename>tariff_selection_generic_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>AB6A7B66</checksum>
-    </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>2.8.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>AEAD3B25</checksum>
+      <checksum>1077D919</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/tariff_selection_time_and_date_dependant/measure.rb

@@ -6,10 +6,6 @@
 # see the URL below for information on how to write OpenStudio measures
 # http://nrel.github.io/OpenStudio-user-documentation/measures/measure_writing_guide/
 
-# load OpenStudio measure libraries from openstudio-extension gem
-require 'openstudio-extension'
-require 'openstudio/extension/core/os_lib_helper_methods'
-
 # start the measure
 class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasure
   # human readable name
@@ -49,6 +45,8 @@ class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasu
     summer_start_month.setDisplayName('Month Summer Begins')
     summer_start_month.setDescription('1-12')
     summer_start_month.setDefaultValue(5)
+    summer_start_month.setMinValue(1.0)
+    summer_start_month.setMaxValue(12.0)
     args << summer_start_month
 
     # adding argument for summer_start_day
@@ -56,6 +54,8 @@ class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasu
     summer_start_day.setDisplayName('Day Summer Begins')
     summer_start_day.setDescription('1-31')
     summer_start_day.setDefaultValue(1)
+    summer_start_day.setMinValue(1.0)
+    summer_start_day.setMaxValue(31.0)
     args << summer_start_day
 
     # adding argument for summer_end_month
@@ -63,6 +63,8 @@ class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasu
     summer_end_month.setDisplayName('Month Summer Ends')
     summer_end_month.setDescription('1-12')
     summer_end_month.setDefaultValue(9)
+    summer_end_month.setMinValue(1.0)
+    summer_end_month.setMaxValue(12.0)
     args << summer_end_month
 
     # adding argument for summer_end_day
@@ -70,6 +72,8 @@ class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasu
     summer_end_day.setDisplayName('Day Summer Ends')
     summer_end_day.setDescription('1-31')
     summer_end_day.setDefaultValue(1)
+    summer_end_day.setMinValue(1.0)
+    summer_end_day.setMaxValue(31.0)
     args << summer_end_day
 
     # adding argument for peak_start_hour
@@ -77,6 +81,8 @@ class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasu
     peak_start_hour.setDisplayName('Hour Peak Begins')
     peak_start_hour.setDescription('1-24')
     peak_start_hour.setDefaultValue(12)
+    peak_start_hour.setMinValue(0.0)
+    peak_start_hour.setMaxValue(24.0)
     args << peak_start_hour
 
     # adding argument for peak_end_hour
@@ -84,6 +90,8 @@ class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasu
     peak_end_hour.setDisplayName('Hour Peak Ends')
     peak_end_hour.setDescription('1-24')
     peak_end_hour.setDefaultValue(18)
+    peak_end_hour.setMinValue(0.0)
+    peak_end_hour.setMaxValue(24.0)
     args << peak_end_hour
 
     # adding argument for elec_rate_sum_peak
@@ -163,20 +171,16 @@ class TariffSelectionTimeAndDateDependant < OpenStudio::Measure::EnergyPlusMeasu
   def run(workspace, runner, user_arguments)
     super(workspace, runner, user_arguments)
 
+    # use the built-in error checking
+    if !runner.validateUserArguments(arguments(workspace), user_arguments)
+      return false
+    end
+
     # assign the user inputs to variables
-    args = OsLib_HelperMethods.createRunVariables(runner, workspace, user_arguments, arguments(workspace))
+    args = runner.getArgumentValues(arguments(workspace), user_arguments)
+    args = Hash[args.collect{ |k, v| [k.to_s, v] }]
     if !args then return false end
 
-    # check expected values of double arguments
-    zero_24 = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 0.0, 'max' => 24.0, 'min_eq_bool' => true, 'max_eq_bool' => true, 'arg_array' => ['peak_start_hour', 'peak_end_hour'])
-    one_31 = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 1.0, 'max' => 31.0, 'min_eq_bool' => true, 'max_eq_bool' => true, 'arg_array' => ['summer_start_day', 'summer_end_day'])
-    one_12 = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 1.0, 'max' => 12.0, 'min_eq_bool' => true, 'max_eq_bool' => true, 'arg_array' => ['summer_start_month', 'summer_end_month'])
-
-    # return false if any errors fail
-    if !zero_24 then return false end
-    if !one_31 then return false end
-    if !one_12 then return false end
-
     # reporting initial condition of model
     starting_tariffs = workspace.getObjectsByType('UtilityCost:Tariff'.to_IddObjectType)
     runner.registerInitialCondition("The model started with #{starting_tariffs.size} tariff objects.")

data/lib/measures/tariff_selection_time_and_date_dependant/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>tariff_selection_time_and_date_dependant</name>
   <uid>a890e296-b357-432f-8d53-6428d9bf3c0a</uid>
-  <version_id>24b6992e-546d-4d0c-a765-f20dfcd4d0ff</version_id>
-  <version_modified>20221115T223606Z</version_modified>
+  <version_id>3396540c-a309-4ace-9d97-788721c99057</version_id>
+  <version_modified>2024-07-11T14:32:09Z</version_modified>
   <xml_checksum>135F7E88</xml_checksum>
   <class_name>TariffSelectionTimeAndDateDependant</class_name>
   <display_name>Tariff Selection-Time and Date Dependant</display_name>
@@ -41,6 +41,8 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>5</default_value>
+      <min_value>1</min_value>
+      <max_value>12</max_value>
     </argument>
     <argument>
       <name>summer_start_day</name>
@@ -50,6 +52,8 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>1</default_value>
+      <min_value>1</min_value>
+      <max_value>31</max_value>
     </argument>
     <argument>
       <name>summer_end_month</name>
@@ -59,6 +63,8 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>9</default_value>
+      <min_value>1</min_value>
+      <max_value>12</max_value>
     </argument>
     <argument>
       <name>summer_end_day</name>
@@ -68,6 +74,8 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>1</default_value>
+      <min_value>1</min_value>
+      <max_value>31</max_value>
     </argument>
     <argument>
       <name>peak_start_hour</name>
@@ -77,6 +85,8 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>12</default_value>
+      <min_value>0.000000</min_value>
+      <max_value>24.000000</max_value>
     </argument>
     <argument>
       <name>peak_end_hour</name>
@@ -86,6 +96,8 @@
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>18</default_value>
+      <min_value>0.000000</min_value>
+      <max_value>24.000000</max_value>
     </argument>
     <argument>
       <name>elec_rate_sum_peak</name>
@@ -252,16 +264,10 @@
   </attributes>
   <files>
     <file>
-      <filename>EnvelopeAndLoadTestModel_01.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>E11F67BD</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>BFFB1AA6</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -270,27 +276,33 @@
       <checksum>C90B29ED</checksum>
     </file>
     <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
-    </file>
-    <file>
-      <filename>tariff_selection_time_and_date_dependant_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>ECB359F4</checksum>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
     </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
         <identifier>2.0.0</identifier>
-        <min_compatible>2.8.0</min_compatible>
+        <min_compatible>3.8.0</min_compatible>
       </version>
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>68ECF8BF</checksum>
+      <checksum>D8EDD118</checksum>
+    </file>
+    <file>
+      <filename>EnvelopeAndLoadTestModel_01.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>E11F67BD</checksum>
+    </file>
+    <file>
+      <filename>tariff_selection_time_and_date_dependant_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>54B0534C</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/view_data/measure.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
+  <schema_version>3.1</schema_version>
   <name>view_data</name>
   <uid>18cf0de7-48b8-48dc-ab68-0dd29f0b8bd0</uid>
-  <version_id>b9f0e42d-44bf-4eed-b121-15624f67d8d8</version_id>
-  <version_modified>20221115T223601Z</version_modified>
+  <version_id>97fe9bbd-3ef0-4d15-a901-b9c11840fa4c</version_id>
+  <version_modified>2024-07-11T14:32:05Z</version_modified>
   <xml_checksum>2C8A3EEF</xml_checksum>
   <class_name>ViewData</class_name>
   <display_name>ViewData</display_name>
@@ -91,22 +91,10 @@
   </attributes>
   <files>
     <file>
-      <filename>SimpleModel.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>AC094EF8</checksum>
-    </file>
-    <file>
-      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
-      <filetype>epw</filetype>
-      <usage_type>test</usage_type>
-      <checksum>BDF687C1</checksum>
-    </file>
-    <file>
-      <filename>README.md.erb</filename>
-      <filetype>erb</filetype>
-      <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>BFFB1AA6</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -115,22 +103,10 @@
       <checksum>70F4784D</checksum>
     </file>
     <file>
-      <filename>ExampleModel.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>FFFE0281</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>64FFEBDE</checksum>
-    </file>
-    <file>
-      <filename>ViewData_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>6D2F71F0</checksum>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
     </file>
     <file>
       <version>
@@ -141,19 +117,43 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>39164A78</checksum>
+      <checksum>1EFC6775</checksum>
+    </file>
+    <file>
+      <filename>report.html.in</filename>
+      <filetype>in</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>98BCA605</checksum>
     </file>
     <file>
       <filename>va3c.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>31AAA47F</checksum>
+      <checksum>7B8C67AE</checksum>
     </file>
     <file>
-      <filename>report.html.in</filename>
-      <filetype>in</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>98BCA605</checksum>
+      <filename>ExampleModel.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>FFFE0281</checksum>
+    </file>
+    <file>
+      <filename>SimpleModel.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>AC094EF8</checksum>
+    </file>
+    <file>
+      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BDF687C1</checksum>
+    </file>
+    <file>
+      <filename>ViewData_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>1ACDE95E</checksum>
     </file>
   </files>
 </measure>