openstudio-analysis 0.3.7 → 0.4.0

data/spec/files/export/analysis/small_seed.json

@@ -14,14 +14,13 @@
 
         ]
       },
-      "name": "Problem",
       "workflow": [
         {
           "measure_definition_class_name": "ReduceLightingLoadsByPercentage",
           "measure_definition_directory": "./measures/reduce_lighting_loads_by_percentage",
           "measure_definition_display_name": "ReduceLightingLoadsByPercentage",
-          "measure_definition_uuid": "35714f63-9663-4406-8142-a6d969554f77",
-          "measure_definition_version_uuid": "7f3d5105-79d2-44c5-8e29-1c2f2b357cce",
+          "measure_definition_uuid": "1ecf6543-f7ed-4050-bfa3-d3d74d532843",
+          "measure_definition_version_uuid": "a4b9b9ec-c704-4bee-a713-d9c6f70888fd",
           "measure_type": "RubyMeasure",
           "arguments": [
             {
@@ -126,21 +125,21 @@
               "value_type": "double",
               "variable": true,
               "variable_type": "RubyContinuousVariable",
-              "uuid": "7f8d5f81-1791-4360-886c-bcb3084f2494",
-              "version_uuid": "ece5e402-9fd2-45bd-9811-1ada2d001f40"
+              "uuid": "029f1527-429f-4497-908f-ee2e54c22cf3",
+              "version_uuid": "040a72b2-e9dd-44d2-9132-8169457ca59b"
             }
           ],
           "workflow_index": 0,
           "workflow_step_type": "Measure",
-          "uuid": "2a17e296-f633-43f4-9137-8ede68d3bf59",
-          "version_uuid": "9df9c6ea-c011-4fab-a51c-eb66bc964ede"
+          "uuid": "46121046-5c72-4107-ac9d-7efd833c1db1",
+          "version_uuid": "1af389e5-a808-47c3-b733-70f4c33f19a8"
         },
         {
           "measure_definition_class_name": "ExampleMeasureAutoDirectoryName",
           "measure_definition_directory": "./measures/example_measure_auto_directory_name",
           "measure_definition_display_name": "ExampleMeasureAutoDirectoryName",
-          "measure_definition_uuid": "7e82e80e-9754-4749-abb9-ca9fbeb9aecb",
-          "measure_definition_version_uuid": "a2afd01c-0802-488f-9328-b3b8c5edf2da",
+          "measure_definition_uuid": "b7f675a9-b83c-42cc-9838-f266cfdba5c6",
+          "measure_definition_version_uuid": "fcbab50e-39a3-41ab-9721-1112589384be",
           "measure_type": "RubyMeasure",
           "arguments": [
             {
@@ -217,21 +216,21 @@
               "value_type": "double",
               "variable": true,
               "variable_type": "RubyContinuousVariable",
-              "uuid": "2a3b40cf-64df-44ea-8789-6a19238b3d24",
-              "version_uuid": "a126c981-7e11-4841-9b90-56230a9a1d37"
+              "uuid": "d8119872-4827-4370-9081-c25f9cee6bc2",
+              "version_uuid": "02bd1fed-86e3-42fb-9a7c-5a9824b97ec0"
             }
           ],
           "workflow_index": 1,
           "workflow_step_type": "Measure",
-          "uuid": "4528d12b-9a6f-4d79-9625-b21aff24a9cf",
-          "version_uuid": "8d8531bc-c3ae-4b29-b537-21dfa20fdc8e"
+          "uuid": "a472385e-3ef2-46ab-bc4b-7a046f2f8c0c",
+          "version_uuid": "f9cdabed-2483-4cfa-9d2f-0828b8a39902"
         },
         {
           "measure_definition_class_name": "ExampleMeasureAutoDirectoryName",
           "measure_definition_directory": "./measures/example_measure_auto_directory_name",
           "measure_definition_display_name": "ExampleMeasureAutoDirectoryName",
-          "measure_definition_uuid": "a47a285b-1e0d-462b-bc07-c847fc2b24e2",
-          "measure_definition_version_uuid": "a45d69b7-e315-4fa7-8cf3-3ac28a0c7b9d",
+          "measure_definition_uuid": "67f87342-a4fa-49e3-8a10-5bac1ba76864",
+          "measure_definition_version_uuid": "7efcd36d-cc25-4512-a116-192dcc8ac467",
           "measure_type": "RubyMeasure",
           "arguments": [
             {
@@ -287,8 +286,8 @@
               "value_type": "double",
               "variable": true,
               "variable_type": "RubyContinuousVariable",
-              "uuid": "94f55b65-1950-4d9a-96c2-89249cfc0ef7",
-              "version_uuid": "fa4e204a-6dca-47b3-8506-9ddfca798516"
+              "uuid": "e1a9ccb7-37f2-4ac8-a16c-a30181385142",
+              "version_uuid": "41ba57dd-1ba9-4bd5-92ed-b061c47ceaa2"
             },
             {
               "argument": {
@@ -332,21 +331,21 @@
               "value_type": "double",
               "variable": true,
               "variable_type": "RubyContinuousVariable",
-              "uuid": "2de91e1a-4eb3-4b5c-92a6-ddb778f3d5ea",
-              "version_uuid": "5bb6ccc1-4207-4907-8ab1-a6e0f61643db"
+              "uuid": "aa86a9d4-e41f-4444-991b-718849d3c000",
+              "version_uuid": "8767f37e-1c02-4371-9e6f-3e63ed4f3962"
             }
           ],
           "workflow_index": 2,
           "workflow_step_type": "Measure",
-          "uuid": "47f7db54-0df3-4e2e-b34d-8fc50e4f7c9a",
-          "version_uuid": "20671249-56c2-4af9-9271-5a32b50dc3d4"
+          "uuid": "f1538361-06ed-4b57-9f93-d32d3970ddfe",
+          "version_uuid": "f23d0f4b-4d59-403d-a3ad-7776f044347d"
         },
         {
           "measure_definition_class_name": "ExampleMeasureAutoDirectoryName",
           "measure_definition_directory": "./measures/example_measure_auto_directory_name",
           "measure_definition_display_name": "ExampleMeasureAutoDirectoryName",
-          "measure_definition_uuid": "49045d84-57be-4589-9c55-766b6665a92f",
-          "measure_definition_version_uuid": "52e753ac-d357-4e1d-8fad-8b2748f8f599",
+          "measure_definition_uuid": "43396da4-1d00-46da-a178-64e953641eb7",
+          "measure_definition_version_uuid": "ed15f139-9d8f-46eb-a2bf-74bb911f04fc",
           "measure_type": "RubyMeasure",
           "arguments": [
             {
@@ -416,21 +415,21 @@
               "value_type": "double",
               "variable": true,
               "variable_type": "RubyContinuousVariable",
-              "uuid": "655ad7a0-f830-41a2-a706-f67e2d1c673c",
-              "version_uuid": "4037db56-3e59-42a9-ade9-2b470f3249f4"
+              "uuid": "b810467d-8fa3-4c8b-926e-2b1932e32564",
+              "version_uuid": "1aeeeb6a-8299-4299-9f62-2e2de4b456b4"
             }
           ],
           "workflow_index": 3,
           "workflow_step_type": "Measure",
-          "uuid": "3c079991-7c3a-41f0-98ec-07c62b800cd1",
-          "version_uuid": "f038a7d6-933f-48aa-b825-61d8212f882d"
+          "uuid": "11328147-211a-4273-8af6-fa5f9b0cb887",
+          "version_uuid": "e93d77a4-aff7-410c-960b-be984f5e46f4"
         },
         {
           "measure_definition_class_name": "ExampleMeasureAutoDirectoryName",
           "measure_definition_directory": "./measures/example_measure_auto_directory_name",
           "measure_definition_display_name": "ExampleMeasureAutoDirectoryName",
-          "measure_definition_uuid": "fc0ddf03-c967-43dc-b3e7-923a52e334d8",
-          "measure_definition_version_uuid": "7dc18acb-0c61-4eed-bc18-5ef646673bb1",
+          "measure_definition_uuid": "f7146d2a-bff6-41bf-8b86-e8cb43348117",
+          "measure_definition_version_uuid": "07973dae-0aba-49a8-81ae-1a2181f5c54f",
           "measure_type": "RubyMeasure",
           "arguments": [
             {
@@ -500,21 +499,21 @@
               "value_type": "double",
               "variable": true,
               "variable_type": "RubyContinuousVariable",
-              "uuid": "41645bf5-f9d6-4959-8025-940b06cdefa4",
-              "version_uuid": "ef3215b3-31ed-4e49-9753-ca98975b5f63"
+              "uuid": "b5ee236a-584a-45b0-b8be-40c92d8ba7a4",
+              "version_uuid": "8cc4205e-b2bf-4f2d-9db0-566b8da625b8"
             }
           ],
           "workflow_index": 4,
           "workflow_step_type": "Measure",
-          "uuid": "be5fd0d0-43d5-44fe-bd57-47ba1802fb84",
-          "version_uuid": "91cc8ea6-a868-4418-8809-8853aa53ab31"
+          "uuid": "8390d255-adce-40cc-85cf-d348ac0dba5d",
+          "version_uuid": "d5d237dc-fd5d-466d-927a-5edbec31679e"
         },
         {
           "measure_definition_class_name": "ExampleMeasureAutoDirectoryName",
           "measure_definition_directory": "./measures/example_measure_auto_directory_name",
           "measure_definition_display_name": "ExampleMeasureAutoDirectoryName",
-          "measure_definition_uuid": "0ef454d1-7e5f-46b9-8b38-5756faf0161a",
-          "measure_definition_version_uuid": "fff1a9a0-85ab-4653-99be-0e36341bfd42",
+          "measure_definition_uuid": "cbf19773-ce7f-48cc-a5d1-638c15033689",
+          "measure_definition_version_uuid": "cd6e0064-ca8c-4d71-a4fb-56fc243bc849",
           "measure_type": "RubyMeasure",
           "arguments": [
             {
@@ -570,14 +569,14 @@
               "value_type": "double",
               "variable": true,
               "variable_type": "RubyContinuousVariable",
-              "uuid": "3a8d1266-a394-48ca-8f03-1be11afdc761",
-              "version_uuid": "d2e290af-824c-4f69-bc60-37187f28e8fc"
+              "uuid": "220b0c95-28c9-420a-8fc6-4d00ccab8dd0",
+              "version_uuid": "e59ae1bd-b7e9-4295-8246-e6426f038119"
             }
           ],
           "workflow_index": 5,
           "workflow_step_type": "Measure",
-          "uuid": "d989b8d4-5083-4ac9-94f2-f58f674c3c85",
-          "version_uuid": "28184cba-00db-4442-94aa-42db19bf5146"
+          "uuid": "d68a5231-f9d6-40fd-b901-25eac3864e21",
+          "version_uuid": "8fd5ffac-6cb4-4023-b60b-a18b0300a6c8"
         }
       ],
       "analysis_type": "lhs"

data/spec/files/export/workflow/analysis.json

@@ -0,0 +1,23 @@
+{
+  "analysis": {
+    "display_name": "workflow",
+    "name": "workflow",
+    "output_variables": [
+
+    ],
+    "problem": {
+      "analysis_type": null,
+      "algorithm": {
+        "objective_functions": [
+
+        ]
+      },
+      "workflow": [
+
+      ]
+    },
+    "seed": null,
+    "weather_file": null,
+    "file_format_version": 1
+  }
+}

data/spec/files/measures/ActualMeasureNoJson/measure.json

@@ -0,0 +1,25 @@
+{
+  "classname": "RotateBuilding",
+  "name": "rotate_building",
+  "display_name": "Rotate Building",
+  "measure_type": "RubyMeasure",
+  "arguments": [
+    {
+      "local_variable": "relative_building_rotation",
+      "variable_type": "Double",
+      "name": "relative_building_rotation",
+      "display_name": "Number of Degrees to Rotate Building",
+      "units": "positive value is clockwise",
+      "description": null,
+      "default_value": 90.0
+    }
+  ],
+  "name_xml": "Rotate Building Relative to Current Orientation",
+  "uid": "a5be6c96-4ecc-47fa-8d32-f4216ebc2e7d",
+  "version_id": "aeb20d61-b773-4d20-a2ef-fe948cdc2858",
+  "modeler_description": "Get the North Axis field for the  OS:Building object and adjusted it based on the user specified value. If the starting value is 20 degrees and the user value is 5 degrees, then the resulting value is 25 degrees.",
+  "description": "Rotate your building relative to its current orientation. This will not rotate site shading objects.",
+  "tags": [
+    "Envelope.Form"
+  ]
+}

data/spec/files/measures/ActualMeasureNoJson/measure.rb

@@ -0,0 +1,80 @@
+#start the measure
+class RotateBuilding < OpenStudio::Ruleset::ModelUserScript
+
+  #define the name that a user will see
+  def name
+    return "Rotate Building"
+  end
+
+  #define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Ruleset::OSArgumentVector.new
+
+    #make an argument for your name
+    relative_building_rotation = OpenStudio::Ruleset::OSArgument::makeDoubleArgument("relative_building_rotation",true)
+    relative_building_rotation.setDisplayName("Number of Degrees to Rotate Building (positive value is clockwise).")
+    relative_building_rotation.setDefaultValue(90.0)
+    args << relative_building_rotation
+
+    return args
+  end #end the arguments method
+
+  #define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+
+    #use the built-in error checking
+    if not runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    #assign the user inputs to variables
+    relative_building_rotation = runner.getDoubleArgumentValue("relative_building_rotation",user_arguments)
+
+    #check the relative_building_rotation for reasonableness
+    if relative_building_rotation > 360 or relative_building_rotation < -360
+      relative_building_rotation = relative_building_rotation -360.0*(relative_building_rotation/360.0).truncate
+      runner.registerWarning("Requested rotation was not between -360 and 360. Effective relative rotation is #{relative_building_rotation} degrees.")
+    end
+
+    #reporting initial condition of model
+    building = model.getBuilding
+    runner.registerValue("orientation_initial",building.northAxis)
+    runner.registerInitialCondition("The building's initial rotation was #{building.northAxis} degrees.")
+
+    #report as not applicable if effective relative rotation is 0
+    if relative_building_rotation == 0
+      runner.registerAsNotApplicable("The requested rotation was 0 degrees. The model was not altered.")
+    else
+      #rotate the building
+      final_building_angle = building.setNorthAxis(building.northAxis + relative_building_rotation)
+      runner.registerInfo("The building has been rotated by #{relative_building_rotation} degrees.")
+    end
+
+    #check for site shading
+    model_contains_site_shading = false
+    shading_surface_groups = model.getShadingSurfaceGroups
+    shading_surface_groups.each do |shading_surface_group|
+      if shading_surface_group.shadingSurfaceType == "Site"
+        model_contains_site_shading = true
+      end
+    end
+
+    #issue warning if site shading surfaces exist
+    if model_contains_site_shading
+      runner.registerWarning("The model contains one or more site shading groups. They were not rotated with the building.")
+    end
+
+    #reporting final condition of model
+    runner.registerValue("orientation_final",building.northAxis)
+    runner.registerFinalCondition("The building's final rotation is #{building.northAxis} degrees.")
+
+    return true
+
+  end #end the run method
+
+
+end #end the measure
+
+#this allows the measure to be used by the application
+RotateBuilding.new.registerWithApplication

data/spec/files/measures/ActualMeasureNoJson/measure.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<measure xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://bcl.nrel.gov/xsd/measures/version/1.0.xsd"><name>Rotate Building Relative to Current Orientation</name><uid>a5be6c96-4ecc-47fa-8d32-f4216ebc2e7d</uid><version_id>aeb20d61-b773-4d20-a2ef-fe948cdc2858</version_id><description>Rotate your building relative to its current orientation. This will not rotate site shading objects.</description><modeler_description>Get the North Axis field for the  OS:Building object and adjusted it based on the user specified value. If the starting value is 20 degrees and the user value is 5 degrees, then the resulting value is 25 degrees.</modeler_description><tags><tag>Envelope.Form</tag></tags><attributes><attribute><name>Measure Type</name><value>ModelMeasure</value><datatype>string</datatype></attribute><attribute><name>Measure Function</name><value>Measure</value><datatype>string</datatype></attribute><attribute><name>Requires EnergyPlus Results</name><value>false</value><datatype>boolean</datatype></attribute><attribute><name>Uses SketchUp API</name><value>false</value><datatype>boolean</datatype></attribute></attributes><files><file><filename>RotateBuilding_TestModel_01.osm</filename><filetype>osm</filetype><usage_type>test</usage_type><checksum>E5C7E0B6</checksum></file><file><filename>RotateBuilding_Test.rb</filename><filetype>rb</filetype><usage_type>test</usage_type><checksum>D9410036</checksum></file><file><version><software_program>OpenStudio</software_program><identifier>1.3.0</identifier></version><filename>measure.rb</filename><filetype>rb</filetype><usage_type>script</usage_type><checksum>FEC15373</checksum></file></files></measure>

data/spec/files/measures/SetThermostatSchedules/measure.json

@@ -0,0 +1,63 @@
+{
+  "classname": "SetThermostatSchedules",
+  "name": "set_thermostat_schedules",
+  "display_name": "Set Thermostat Schedules",
+  "measure_type": "RubyMeasure",
+  "arguments": [
+    {
+      "local_variable": "zones",
+      "variable_type": "Choice",
+      "name": "zones",
+      "display_name": "Choose Thermal Zones to change thermostat schedules on",
+      "units": null,
+      "description": null,
+      "default_value": "*All Thermal Zones*",
+      "choices": [
+        "*All Thermal Zones*"
+      ]
+    },
+    {
+      "local_variable": "cooling_sch",
+      "variable_type": "Choice",
+      "name": "cooling_sch",
+      "display_name": "Choose Cooling Schedule",
+      "units": null,
+      "description": null,
+      "default_value": "*No Change*",
+      "choices": [
+        "",
+        "*No Change*"
+      ]
+    },
+    {
+      "local_variable": "heating_sch",
+      "variable_type": "Choice",
+      "name": "heating_sch",
+      "display_name": "Choose Heating Schedule",
+      "units": null,
+      "description": null,
+      "default_value": "*No Change*",
+      "choices": [
+        "",
+        "*No Change*"
+      ]
+    },
+    {
+      "local_variable": "material_cost",
+      "variable_type": "Double",
+      "name": "material_cost",
+      "display_name": "Material and Installation Costs per Thermal Zone",
+      "units": "$/thermal zone",
+      "description": null,
+      "default_value": 0.0
+    }
+  ],
+  "name_xml": "Set Thermostat Schedules",
+  "uid": "d241d623-d596-4b26-9b67-fe390be1e839",
+  "version_id": "699b90d0-1b73-4208-869a-c6987afda0da",
+  "modeler_description": "Sets zone thermostat schedules to schedules in the same file. If a zone does not have a thermostat this measure will add one.",
+  "description": "Sets zone thermostat schedules to schedules in the same file. If a zone does not have a thermostat this measure will add one",
+  "tags": [
+    "HVAC.HVAC Controls"
+  ]
+}

data/spec/files/measures/SetThermostatSchedules/measure.rb

@@ -0,0 +1,254 @@
+#see the URL below for information on how to write OpenStuido measures
+# http://openstudio.nrel.gov/openstudio-measure-writing-guide
+
+#start the measure
+class SetThermostatSchedules < OpenStudio::Ruleset::ModelUserScript
+  
+  #define the name that a user will see, this method may be deprecated as
+  #the display name in PAT comes from the name field in measure.xml
+  def name
+    return "Set Thermostat Schedules"
+  end
+  
+  #define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Ruleset::OSArgumentVector.new
+    
+    #populate choice argument for thermal zones in the model
+    zone_handles = OpenStudio::StringVector.new
+    zone_display_names = OpenStudio::StringVector.new
+
+    #putting zone names into hash
+    zone_hash = {}
+    model.getThermalZones.each do |zone|
+      zone_hash[zone.name.to_s] = zone
+    end
+
+    #looping through sorted hash of zones
+    zone_hash.sort.map do |zone_name, zone|
+      if zone.thermostatSetpointDualSetpoint.is_initialized
+        zone_handles << zone.handle.to_s
+        zone_display_names << zone_name
+      end
+    end
+
+    #add building to string vector with zones
+    building = model.getBuilding
+    zone_handles << building.handle.to_s
+    zone_display_names << "*All Thermal Zones*"
+    
+    #make an argument for zones
+    zones = OpenStudio::Ruleset::OSArgument::makeChoiceArgument("zones", zone_handles, zone_display_names, true)
+    zones.setDisplayName("Choose Thermal Zones to change thermostat schedules on.")
+    zones.setDefaultValue("*All Thermal Zones*") #if no zone is chosen this will run on all zones
+    args << zones
+
+    #populate choice argument for schedules in the model
+    sch_handles = OpenStudio::StringVector.new
+    sch_display_names = OpenStudio::StringVector.new
+
+    #putting schedule names into hash
+    sch_hash = {}
+    model.getSchedules.each do |sch|
+      sch_hash[sch.name.to_s] = sch
+    end
+
+    #looping through sorted hash of schedules
+    sch_hash.sort.map do |sch_name, sch|
+      if not sch.scheduleTypeLimits.empty?
+        unitType = sch.scheduleTypeLimits.get.unitType
+        #puts "#{sch.name}, #{unitType}"
+        if unitType == "Temperature"
+          sch_handles << sch.handle.to_s
+          sch_display_names << sch_name
+        end
+      end
+    end
+
+    #add empty handle to string vector with schedules
+    sch_handles << OpenStudio::toUUID("").to_s
+    sch_display_names << "*No Change*"
+    
+    #make an argument for cooling schedule
+    cooling_sch = OpenStudio::Ruleset::OSArgument::makeChoiceArgument("cooling_sch", sch_handles, sch_display_names, true)
+    cooling_sch.setDisplayName("Choose Cooling Schedule.")
+    cooling_sch.setDefaultValue("*No Change*") #if no change is chosen then cooling schedules will not be changed
+    args << cooling_sch    
+
+    #make an argument for heating schedule
+    heating_sch = OpenStudio::Ruleset::OSArgument::makeChoiceArgument("heating_sch", sch_handles, sch_display_names, true)
+    heating_sch.setDisplayName("Choose Heating Schedule.")
+    heating_sch.setDefaultValue("*No Change*") #if no change is chosen then heating schedules will not be changed
+    args << heating_sch
+    
+    #make an argument for material and installation cost
+    material_cost = OpenStudio::Ruleset::OSArgument::makeDoubleArgument("material_cost",true)
+    material_cost.setDisplayName("Material and Installation Costs per Thermal Zone ($/thermal zone).")
+    material_cost.setDefaultValue(0.0)
+    args << material_cost
+    
+    return args
+  end #end the arguments method
+
+  #define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+    
+    #use the built-in error checking 
+    if not runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    #assign the user inputs to variables
+    zones = runner.getOptionalWorkspaceObjectChoiceValue("zones",user_arguments,model) #model is passed in because of argument type
+    cooling_sch = runner.getOptionalWorkspaceObjectChoiceValue("cooling_sch",user_arguments,model) #model is passed in because of argument type
+    heating_sch = runner.getOptionalWorkspaceObjectChoiceValue("heating_sch",user_arguments,model) #model is passed in because of argument type
+    material_cost = runner.getDoubleArgumentValue("material_cost",user_arguments)
+    
+    #check the zone selection for reasonableness
+    apply_to_all_zones = false
+    selected_zone = nil
+    if zones.empty?
+      handle = runner.getStringArgumentValue("zones",user_arguments)
+      if handle.empty?
+        runner.registerError("No thermal zone was chosen.")
+        return false
+      else
+        runner.registerError("The selected thermal zone with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
+        return false
+      end
+    else
+      if not zones.get.to_ThermalZone.empty?
+        selected_zone = zones.get.to_ThermalZone.get
+      elsif not zones.get.to_Building.empty?
+        apply_to_all_zones = true
+      else
+        runner.registerError("Script Error - argument not showing up as thermal zone.")
+        return false
+      end
+    end  #end of if zones.empty?
+    
+    #depending on user input, add selected zones to an array
+    selected_zones = [] 
+    if apply_to_all_zones == true
+      selected_zones = model.getThermalZones
+    else
+      selected_zones << selected_zone
+    end
+
+    #check the cooling_sch for reasonableness
+    if cooling_sch.empty?
+      handle = runner.getStringArgumentValue("cooling_sch",user_arguments)
+      if handle == OpenStudio::toUUID("").to_s
+        # no change
+        cooling_sch = nil
+      else
+        runner.registerError("The selected schedule with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
+        return false
+      end
+    else
+      if not cooling_sch.get.to_Schedule.empty?
+        cooling_sch = cooling_sch.get.to_Schedule.get
+      else
+        runner.registerError("Script Error - argument not showing up as schedule.")
+        return false
+      end
+    end  #end of if cooling_sch.empty?
+
+    #check the heating_sch for reasonableness
+    if heating_sch.empty?
+      handle = runner.getStringArgumentValue("heating_sch",user_arguments)
+      if handle == OpenStudio::toUUID("").to_s
+        # no change
+        heating_sch = nil
+      else
+        runner.registerError("The selected schedule with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
+        return false
+      end
+    else
+      if not heating_sch.get.to_Schedule.empty?
+        heating_sch = heating_sch.get.to_Schedule.get
+      else
+        runner.registerError("Script Error - argument not showing up as schedule.")
+        return false
+      end
+    end  #end of if heating_sch.empty?
+      
+    number_zones_modified = 0
+    total_cost = 0
+    if heating_sch or cooling_sch
+    
+      selected_zones.each do |zone|
+        
+        thermostatSetpointDualSetpoint = zone.thermostatSetpointDualSetpoint
+        if thermostatSetpointDualSetpoint.empty?
+          runner.registerInfo("Creating thermostat for thermal zone '#{zone.name}'.")
+          
+          thermostatSetpointDualSetpoint = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(model)
+          zone.setThermostatSetpointDualSetpoint(thermostatSetpointDualSetpoint)
+        else
+          thermostatSetpointDualSetpoint = thermostatSetpointDualSetpoint.get
+          
+          # make sure this thermostat is unique to this zone
+          if thermostatSetpointDualSetpoint.getSources("OS_ThermalZone".to_IddObjectType).size > 1
+            # if not create a new copy
+            runner.registerInfo("Copying thermostat for thermal zone '#{zone.name}'.")
+            
+            oldThermostat = thermostatSetpointDualSetpoint
+            thermostatSetpointDualSetpoint = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(model)
+            if not oldThermostat.heatingSetpointTemperatureSchedule.empty?
+              thermostatSetpointDualSetpoint.setHeatingSetpointTemperatureSchedule(oldThermostat.heatingSetpointTemperatureSchedule.get)
+            end
+            if not oldThermostat.coolingSetpointTemperatureSchedule.empty?
+              thermostatSetpointDualSetpoint.setCoolingSetpointTemperatureSchedule(oldThermostat.coolingSetpointTemperatureSchedule.get)
+            end
+            zone.setThermostatSetpointDualSetpoint(thermostatSetpointDualSetpoint)
+          end
+        end
+        
+        if heating_sch
+          if not thermostatSetpointDualSetpoint.setHeatingSetpointTemperatureSchedule(heating_sch)
+            runner.registerError("Script Error - cannot set heating schedule for thermal zone '#{zone.name}'.")
+            return false
+          end
+        end
+        
+        if cooling_sch
+          if not thermostatSetpointDualSetpoint.setCoolingSetpointTemperatureSchedule(cooling_sch)
+            runner.registerError("Script Error - cannot set cooling schedule for thermal zone '#{zone.name}'.")
+            return false
+          end
+        end
+        
+        if material_cost.abs != 0
+          total_cost += material_cost
+          OpenStudio::Model::LifeCycleCost::createLifeCycleCost("LCC_Mat - #{zone.name} Thermostats", zone, material_cost, "CostPerEach", "Construction")
+        end
+        
+        number_zones_modified += 1
+      end
+    end
+    
+    runner.registerFinalCondition("Replaced thermostats for #{number_zones_modified} thermal zones, capital cost #{total_cost}")                   
+
+    if number_zones_modified == 0
+      runner.registerAsNotApplicable("No thermostats altered")
+    end
+    
+    return true
+ 
+  end #end the run method
+
+end #end the measure
+
+#this allows the measure to be use by the application
+SetThermostatSchedules.new.registerWithApplication
+
+
+
+
+
+
+
+
+

data/spec/files/measures/SetThermostatSchedules/measure.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<measure xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://bcl.nrel.gov/xsd/measures/version/1.0.xsd"><name>Set Thermostat Schedules</name><uid>d241d623-d596-4b26-9b67-fe390be1e839</uid><version_id>699b90d0-1b73-4208-869a-c6987afda0da</version_id><description>Sets zone thermostat schedules to schedules in the same file. If a zone does not have a thermostat this measure will add one</description><modeler_description>Sets zone thermostat schedules to schedules in the same file. If a zone does not have a thermostat this measure will add one.</modeler_description><tags><tag>HVAC.HVAC Controls</tag></tags><attributes><attribute><name>Measure Function</name><value>Measure</value><datatype>string</datatype></attribute><attribute><name>Requires EnergyPlus Results</name><value>false</value><datatype>boolean</datatype></attribute><attribute><name>Measure Type</name><value>ModelMeasure</value><datatype>string</datatype></attribute><attribute><name>Uses SketchUp API</name><value>false</value><datatype>boolean</datatype></attribute></attributes><files><file><filename>SetThermostatSchedules_Test.rb</filename><filetype>rb</filetype><usage_type>test</usage_type><checksum>215A22F5</checksum></file><file><version><software_program>OpenStudio</software_program><identifier>1.2.0</identifier></version><filename>measure.rb</filename><filetype>rb</filetype><usage_type>script</usage_type><checksum>764BA2C0</checksum></file></files></measure>