Module: OpenStudio::Workflow::Util::Measure

Included in:
RunEnergyPlusMeasures, RunInitialization, RunOpenStudioMeasures, RunPreprocess, RunReportingMeasures
Defined in:
lib/openstudio/workflow/util/measure.rb

Overview

Handles all interaction with measure objects in the gem. This includes measure.xml and measure.rb files

Instance Method Summary collapse

Instance Method Details

#add_result_measure_info(result, measure) ⇒ Object

Method to add measure info to WorkflowStepResult

Parameters:

  • result (Object)

    Current WorkflowStepResult

  • measure (Object)

    Current BCLMeasure



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/openstudio/workflow/util/measure.rb', line 237

def add_result_measure_info(result, measure)
  begin
    result.setMeasureType(measure.measureType)
    result.setMeasureName(measure.name)
    result.setMeasureId(measure.uid)
    result.setMeasureVersionId(measure.versionId)
    version_modified = measure.versionModified
    if !version_modified.empty?
      result.setMeasureVersionModified(version_modified.get)
    end
    result.setMeasureXmlChecksum(measure.xmlChecksum)
    result.setMeasureClassName(measure.className)
    result.setMeasureDisplayName(measure.displayName)
    result.setMeasureTaxonomy(measure.taxonomyTag)
  rescue NameError
  end
end

#apply_arguments(argument_map, argument_name, argument_value, logger) ⇒ Object

Sets the argument map for argument_map argument pair

Parameters:

  • argument_map (Object)

    See the OpenStudio SDK for a description of the OSArgumentMap structure

  • argument_name, (Object)

    user defined argument name

  • argument_value, (Object)

    user defined argument value

  • logger, (Object)

    logger object

Returns:

  • (Object)

    Returns an updated ArgumentMap object



191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/openstudio/workflow/util/measure.rb', line 191

def apply_arguments(argument_map, argument_name, argument_value, logger)
  unless argument_value.nil?
    logger.info "Setting argument value '#{argument_name}' to '#{argument_value}'"

    v = argument_map[argument_name.to_s]
    fail "Could not find argument '#{argument_name}' in argument_map" unless v
    value_set = v.setValue(argument_value)
    fail "Could not set argument '#{argument_name}' to value '#{argument_value}'" unless value_set
    argument_map[argument_name.to_s] = v.clone
  else
    logger.warn "Value for argument '#{argument_name}' not set in argument list therefore will use default"
  end
end

#apply_arguments_2(argument_map, argument_name, argument_value, logger) ⇒ Object



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/openstudio/workflow/util/measure.rb', line 205

def apply_arguments_2(argument_map, argument_name, argument_value, logger)
  unless argument_value.nil?
    logger.info "Setting argument value '#{argument_name}' to '#{argument_value}'"

    v = argument_map[argument_name.to_s]
    fail "Could not find argument '#{argument_name}' in argument_map" unless v
    value_set = false
    variant_type = argument_value.variantType
    if variant_type == "String".to_VariantType
      argument_value = argument_value.valueAsString
      value_set = v.setValue(argument_value)
    elsif variant_type == "Double".to_VariantType
      argument_value = argument_value.valueAsDouble
      value_set = v.setValue(argument_value)
    elsif variant_type == "Integer".to_VariantType
      argument_value = argument_value.valueAsInteger
      value_set = v.setValue(argument_value)
    elsif variant_type == "Boolean".to_VariantType
      argument_value = argument_value.valueAsBoolean
      value_set = v.setValue(argument_value)
    end
    fail "Could not set argument '#{argument_name}' to value '#{argument_value}'" unless value_set
    argument_map[argument_name.to_s] = v.clone
  else
    logger.warn "Value for argument '#{argument_name}' not set in argument list therefore will use default"
  end
end

#apply_measure(registry, step, options = {}, energyplus_output_requests = false, halted = false) ⇒ Hash, String

Method to allow for a single measure of any type to be run

Parameters:

  • directory (String)

    Location of the datapoint directory to run. This is needed independent of the adapter that is being used. Note that the simulation will actually run in ‘run’

  • adapter (Object)

    An instance of the adapter class

  • current_weather_filepath (String)

    The path which will be used to set the runner and returned to update the OSW for future measures and the simulation

  • model (Object)

    The model object being used in the measure, either a OSM or IDF

  • step (Hash)

    Definition of the to be run by the workflow

  • output_attributes (Hash)

    The results of previous measure applications which are persisted through the runner to allow measures to react to previous events in the workflow

  • options (Hash) (defaults to: {})

    ({}) User-specified options used to override defaults

  • energyplus_output_requests (Boolean) (defaults to: false)

    If true then the energyPlusOutputRequests is called instead of the run method

  • halted (Boolean) (defaults to: false)

    True if the workflow has been halted and all measures should be skipped

Options Hash (step):

  • :measure_dir_name (String)

    The name of the directory which contains the measure files

  • :arguments (Object)

    name value hash which defines the arguments to the measure, e.g. true, cost: 3.1

Options Hash (options):

  • :measure_search_array (Array)

    Ordered set of measure directories used to search for step, e.g. [‘measures’, ‘../../measures’]

  • :time_logger (Object)

    Special logger used to debug performance issues

Returns:

  • (Hash, String)

    Returns two objects. The first is the (potentially) updated output_attributes hash, and the second is the (potentially) updated current_weather_filepath



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
# File 'lib/openstudio/workflow/util/measure.rb', line 278

def apply_measure(registry, step, options = {}, energyplus_output_requests = false, halted = false)

  logger = registry[:logger]
  runner = registry[:runner]
  workflow_json = registry[:workflow_json]
  measure_dir_name = step.measureDirName

  run_dir = registry[:run_dir]
  fail 'No run directory set in the registry' unless run_dir

  output_attributes = registry[:output_attributes]

  # todo: get weather file from appropriate location
  @wf = registry[:wf]
  @model = registry[:model]
  @model_idf = registry[:model_idf]
  @sql_filename = registry[:sql]

  runner.setLastOpenStudioModel(@model) if @model
  #runner.setLastOpenStudioModelPath(const openstudio::path& lastOpenStudioModelPath); #DLM - deprecate?
  runner.setLastEnergyPlusWorkspace(@model_idf) if @model_idf
  #runner.setLastEnergyPlusWorkspacePath(const openstudio::path& lastEnergyPlusWorkspacePath); #DLM - deprecate?
  runner.setLastEnergyPlusSqlFilePath(@sql_filename) if @sql_filename
  runner.setLastEpwFilePath(@wf) if @wf

  logger.debug "Starting #{__method__} for #{measure_dir_name}"
  registry[:time_logger].start("Measure:#{measure_dir_name}") if registry[:time_logger]
  current_dir = Dir.pwd

  success = nil
  begin

    measure_dir = workflow_json.findMeasure(measure_dir_name)
    fail "Cannot find #{measure_dir_name}" if measure_dir.empty?
    measure_dir = measure_dir.get

    measure = OpenStudio::BCLMeasure.load(measure_dir)
    fail "Cannot load measure at #{measure_dir}" if measure.empty?
    measure = measure.get

    step_index = workflow_json.currentStepIndex

    measure_run_dir = File.join(run_dir, "#{step_index.to_s.rjust(3,'0')}_#{measure_dir_name}")
    logger.debug "Creating run directory for measure in #{measure_run_dir}"
    FileUtils.mkdir_p measure_run_dir
    Dir.chdir measure_run_dir

    if energyplus_output_requests
      logger.debug "energyPlusOutputRequests running in #{Dir.pwd}"
    else
      logger.debug "Apply measure running in #{Dir.pwd}"
    end

    class_name = measure.className
    measure_type = measure.measureType

    measure_path = measure.primaryRubyScriptPath
    fail "Measure does not have a primary ruby script specified" if measure_path.empty?
    measure_path = measure_path.get
    fail "#{measure_path} file does not exist" unless File.exist?(measure_path.to_s)

    logger.debug "Loading Measure from #{measure_path}"

    measure_object = nil
    result = nil
    begin
      load measure_path.to_s
      # load.c in ruby can result in changing dir to root / so preserve cwd here. happens in openstudio cli 
      Dir.chdir measure_run_dir 
      measure_object = Object.const_get(class_name).new
    rescue => e

      # add the error to the osw.out
      runner.registerError("#{e.message}\n\t#{e.backtrace.join("\n\t")}")

      # @todo (rhorsey) Clean up the error class here.
      log_message = "Error requiring measure #{__FILE__}. Failed with #{e.message}, #{e.backtrace.join("\n")}"
      raise log_message
    end

    arguments = nil
    skip_measure = false
    begin

      # Initialize arguments which may be model dependent, don't allow arguments method access to real model in case it changes something
      if measure_type == 'ModelMeasure'.to_MeasureType
        arguments = measure_object.arguments(@model.clone(true).to_Model)
      elsif measure_type == 'EnergyPlusMeasure'.to_MeasureType
        arguments = measure_object.arguments(@model_idf.clone(true))
      else measure_type == 'ReportingMeasure'.to_MeasureType
        # arity gives the number of expected arguments
        # We handle the case where n_args == 0 for backward compatibility
        n_args = measure_object.method(:arguments).arity
        if (n_args == 0)
          logger.warn "Reporting Measure at #{measure_path} is using the old format where the 'arguments' method does not take model. Please consider updating this to `def arguments(model)`."
          arguments = measure_object.arguments
        else
          arguments = measure_object.arguments(@model.clone(true).to_Model)
        end
      end

      # Create argument map and initialize all the arguments
      argument_map = OpenStudio::Ruleset::OSArgumentMap.new
      if arguments
        arguments.each do |v|
          argument_map[v.name] = v.clone
        end
      end

      # Set argument values if they exist
      logger.debug "Iterating over arguments for workflow item '#{measure_dir_name}'"
      if step.arguments

        # handle skip first
        argument_value = step.arguments['__SKIP__']
        if !argument_value.nil?

          if registry[:openstudio_2]
            variant_type = argument_value.variantType
            if variant_type == "String".to_VariantType
              argument_value = argument_value.valueAsString
            elsif variant_type == "Double".to_VariantType
              argument_value = argument_value.valueAsDouble
            elsif variant_type == "Integer".to_VariantType
              argument_value = argument_value.valueAsInteger
            elsif variant_type == "Boolean".to_VariantType
              argument_value = argument_value.valueAsBoolean
            end
          end

          if argument_value.class == String
            argument_value = argument_value.downcase
            if argument_value == "false"
              skip_measure = false
            else
              skip_measure = true
            end
          elsif argument_value.class == Fixnum
            skip_measure = (argument_value != 0)
          elsif argument_value.class == Float
            skip_measure = (argument_value != 0.0)
          elsif argument_value.class == FalseClass
            skip_measure = false
          elsif argument_value.class == TrueClass
            skip_measure = true
          elsif argument_value.class == NilClass
            skip_measure = false
          end
        end

        # process other arguments
        step.arguments.each do |argument_name, argument_value|

          # don't validate choices if measure is being skipped
          next if skip_measure

          # already handled skip
          next if argument_name.to_s == '__SKIP__'

          # regular argument
          if registry[:openstudio_2]
            success = apply_arguments_2(argument_map, argument_name, argument_value, logger)
          else
            success = apply_arguments(argument_map, argument_name, argument_value, logger)
          end
          fail 'Could not set arguments' unless success
        end

      end

      # map any choice display names to choice values, in either set values or defaults
      argument_map.each_key do |argument_name|

        # don't validate choices if measure is being skipped
        next if skip_measure

        v = argument_map[argument_name]
        choice_values = v.choiceValues
        if !choice_values.empty?
          value = nil
          value = v.defaultValueAsString if v.hasDefaultValue
          value = v.valueAsString if v.hasValue
          if value && choice_values.index(value).nil?
            display_names = v.choiceValueDisplayNames
            i = display_names.index(value)
            if i && choice_values[i]
              logger.debug "Mapping display name '#{value}' to value '#{choice_values[i]}' for argument '#{argument_name}'"
              value_set = v.setValue(choice_values[i])
              fail "Could not set argument '#{argument_name}' to mapped value '#{choice_values[i]}'" unless value_set
              argument_map[argument_name.to_s] = v.clone
            end
          end
        end
      end

    rescue => e

      # add the error to the osw.out
      runner.registerError("#{e.message}\n\t#{e.backtrace.join("\n\t")}")

      log_message = "Error assigning argument in measure #{__FILE__}. Failed with #{e.message}, #{e.backtrace.join("\n")}"
      raise log_message
    end

    if skip_measure || halted
      if !energyplus_output_requests
        if halted
          # if halted then this measure will not get run, there are no results, not even "Skip"
          logger.info "Skipping measure '#{measure_dir_name}' because simulation halted"

        else
          logger.info "Skipping measure '#{measure_dir_name}'"

          # required to update current step, will do nothing if halted
          runner.prepareForUserScriptRun(measure_object)

          # don't want to log errors about arguments passed to skipped measures
          #runner.validateUserArguments(arguments, argument_map

          current_result = runner.result
          runner.incrementStep
          add_result_measure_info(current_result, measure)
          current_result.setStepResult('Skip'.to_StepResult)
        end
      end
    else

      begin
        if energyplus_output_requests
          logger.debug "Calling measure.energyPlusOutputRequests for '#{measure_dir_name}'"
          idf_objects = measure_object.energyPlusOutputRequests(runner, argument_map)
          num_added = 0
          idf_objects.each do |idf_object|
            num_added += OpenStudio::Workflow::Util::EnergyPlus.add_energyplus_output_request(@model_idf, idf_object)
          end
          logger.debug "Finished measure.energyPlusOutputRequests for '#{measure_dir_name}', #{num_added} output requests added"
        else
          logger.debug "Calling measure.run for '#{measure_dir_name}'"
          if measure_type == 'ModelMeasure'.to_MeasureType
            measure_object.run(@model, runner, argument_map)
          elsif measure_type == 'EnergyPlusMeasure'.to_MeasureType
            measure_object.run(@model_idf, runner, argument_map)
          elsif measure_type == 'ReportingMeasure'.to_MeasureType
            measure_object.run(runner, argument_map)
          end
          logger.debug "Finished measure.run for '#{measure_dir_name}'"
        end

        # Run garbage collector after every measure to help address race conditions
        GC.start
      rescue => e

        # add the error to the osw.out
        runner.registerError("#{e.message}\n\t#{e.backtrace.join("\n\t")}")

        result = runner.result

        if !energyplus_output_requests
          # incrementStep must be called after run
          runner.incrementStep

          add_result_measure_info(result, measure)
        end

        options[:output_adapter].communicate_measure_result(result) if options[:output_adapter]

        log_message = "Runner error #{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
        raise log_message
      end

      # if doing output requests we are done now
      if energyplus_output_requests
        registry.register(:model_idf) { @model_idf }
        return
      end

      result = nil
      begin
        result = runner.result

        # incrementStep must be called after run
        runner.incrementStep

        add_result_measure_info(result, measure)

        options[:output_adapter].communicate_measure_result(result) if options[:output_adapter]

        errors = result.stepErrors

        fail "Measure #{measure_dir_name} reported an error with #{errors}" if errors.size != 0
        logger.debug "Running of measure '#{measure_dir_name}' completed. Post-processing measure output"

        # TODO: fix this
        #unless @wf == runner.weatherfile_path
        #  logger.debug "Updating the weather file to be '#{runner.weatherfile_path}'"
        #  registry.register(:wf) { runner.weatherfile_path }
        #end

        # @todo add note about why reassignment and not eval
        registry.register(:model) { @model }
        registry.register(:model_idf) { @model_idf }
        registry.register(:sql) { @sql_filename }

        if measure_type == 'ModelMeasure'.to_MeasureType
          # check if weather file has changed
          weather_file = @model.getOptionalWeatherFile
          if !weather_file.empty?
            weather_file_path = weather_file.get.path
            if weather_file_path.empty?
              logger.debug "Weather file object found in model but no path is given"
            else
              weather_file_path2 = workflow_json.findFile(weather_file_path.get)
              if weather_file_path2.empty?
                logger.warn "Could not find weather file '#{weather_file_path}' referenced in model"
              else
                if weather_file_path2.get.to_s != @wf
                  logger.debug "Updating weather file path to '#{weather_file_path2.get.to_s}'"
                  @wf = weather_file_path2.get.to_s
                  registry.register(:wf) { @wf }
                end
              end
            end
          end
        end

      rescue => e
        log_message = "Runner error #{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
        raise log_message
      end

      # DLM: this section creates the measure_attributes.json file which should be deprecated
      begin
        measure_name = step.name.is_initialized ? step.name.get : class_name

        output_attributes[measure_name.to_sym] = {} if output_attributes[measure_name.to_sym].nil?

        result.stepValues.each do |step_value|
          step_value_name = step_value.name
          step_value_type = step_value.variantType

          value = nil
          if (step_value_type == "String".to_VariantType)
            value = step_value.valueAsString
          elsif (step_value_type == "Double".to_VariantType)
            value = step_value.valueAsDouble
          elsif (step_value_type == "Integer".to_VariantType)
            value = step_value.valueAsInteger
          elsif (step_value_type == "Boolean".to_VariantType)
            value = step_value.valueAsBoolean
          end

          output_attributes[measure_name.to_sym][step_value_name] = value
        end

        # Add an applicability flag to all the measure results
        step_result = result.stepResult
        fail "Step Result not set" if step_result.empty?
        step_result = step_result.get

        if (step_result == "Skip".to_StepResult) || (step_result == "NA".to_StepResult)
          output_attributes[measure_name.to_sym][:applicable] = false
        else
          output_attributes[measure_name.to_sym][:applicable] = true
        end
        registry.register(:output_attributes) { output_attributes }
      rescue => e
        log_message = "#{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
        logger.error log_message
        raise log_message
      end

    end

  rescue ScriptError, StandardError, NoMemoryError => e
    log_message = "#{__FILE__} failed with message #{e.message} in #{e.backtrace.join("\n")}"
    logger.error log_message
    raise log_message
  ensure
    Dir.chdir current_dir
    registry[:time_logger].stop("Measure:#{measure_dir_name}") if registry[:time_logger]

    logger.info "Finished #{__method__} for #{measure_dir_name} in #{@registry[:time_logger].delta("Measure:#{measure_dir_name}")} s" if registry[:time_logger]
  end
end

#apply_measures(measure_type, registry, options = {}, energyplus_output_requests = false) ⇒ Void

Wrapper method around #apply_measure to allow all measures of a type to be executed

Parameters:

  • measure_type (String)

    Accepts OpenStudio::MeasureType argument

  • registry (Object)

    Hash access to objects

  • options (Hash) (defaults to: {})

    ({}) User-specified options used to override defaults

  • energyplus_output_requests (Boolean) (defaults to: false)

    If true then the energyPlusOutputRequests is called instead of the run method

Options Hash (options):

  • :time_logger (Object)

    A special logger used to debug performance issues

  • :output_adapter (Object)

    An output adapter to register measure transitions to

Returns:

  • (Void)


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/openstudio/workflow/util/measure.rb', line 54

def apply_measures(measure_type, registry, options = {}, energyplus_output_requests = false)

  # DLM: time_logger is in the registry but docs say it is in options?
  registry[:time_logger].start "#{measure_type.valueName}:apply_measures" if registry[:time_logger]

  logger = registry[:logger]
  runner = registry[:runner]
  workflow_json = registry[:workflow_json]

  workflow_steps = workflow_json.workflowSteps
  fail "The 'steps' array of the OSW is required." unless workflow_steps

  logger.debug "Finding measures of type #{measure_type.valueName}"
  workflow_steps.each_index do |step_index|

    step = workflow_steps[step_index]

    if @registry[:openstudio_2]
      if !step.to_MeasureStep.empty?
        step = step.to_MeasureStep.get
      end
    end

    measure_dir_name = step.measureDirName

    pn = Pathname.new(measure_dir_name)
    if pn.absolute?
      logger.warn "measure_dir_name should not be a full path. It should be a relative path to the measure directory or the name of the measure directory containing the measure.rb file."
    end

    measure_dir = workflow_json.findMeasure(measure_dir_name)
    fail "Cannot find #{measure_dir_name}" if measure_dir.empty?
    measure_dir = measure_dir.get

    measure = OpenStudio::BCLMeasure.load(measure_dir)
    fail "Cannot load measure at #{measure_dir}" if measure.empty?
    measure = measure.get

    class_name = measure.className
    measure_instance_type = measure.measureType
    if measure_instance_type == measure_type
      if energyplus_output_requests
        logger.info "Found measure #{class_name} of type #{measure_type.valueName}. Collecting EnergyPlus Output Requests now."
        apply_measure(registry, step, options, energyplus_output_requests)
      else
        logger.info "Found measure #{class_name} of type #{measure_type.valueName}. Applying now."

        # check if simulation has been halted
        halted = runner.halted

        # fast forward current step index to this index, skips any previous steps
        # DLM: this is needed when running reporting measures only
        if !halted
          while workflow_json.currentStepIndex < step_index
            workflow_json.incrementStep
          end
        end

        # DLM: why is output_adapter in options instead of registry?
        options[:output_adapter].communicate_transition("Applying #{class_name}", :measure) if options[:output_adapter]
        apply_measure(registry, step, options, energyplus_output_requests, halted)
        options[:output_adapter].communicate_transition("Applied #{class_name}", :measure) if options[:output_adapter]
      end

      logger.info 'Moving to the next workflow step.'
    else
      logger.debug "Passing measure #{class_name} of type #{measure_type.valueName}"
    end
  end

  registry[:time_logger].stop "#{measure_type.valueName}:apply_measures" if registry[:time_logger]
end

#validate_measures(registry, logger) ⇒ true

Determine if a given workflow can find and load all measures defined in steps

Parameters:

  • workflow (Hash)

    See the schema for an OSW defined in the spec folder of this repo. Note that this method requires the OSW to have been loaded with symbolized keys

  • directory (String)

    The directory that will be passed to the find_measure_dir method

Returns:

  • (true)

    If the method doesn’t fail the workflow measures were validated



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/openstudio/workflow/util/measure.rb', line 134

def validate_measures(registry, logger)

  logger = registry[:logger] if logger.nil?
  workflow_json = registry[:workflow_json]

  state = 'ModelMeasure'.to_MeasureType
  steps = workflow_json.workflowSteps
  steps.each_with_index do |step, index|
    begin
      logger.debug "Validating step #{index}"

      if @registry[:openstudio_2]
        if !step.to_MeasureStep.empty?
          step = step.to_MeasureStep.get
        end
      end

      # Verify the existence of the required files
      measure_dir_name = step.measureDirName

      measure_dir = workflow_json.findMeasure(measure_dir_name)
      fail "Cannot find measure #{measure_dir_name}" if measure_dir.empty?
      measure_dir = measure_dir.get

      measure = OpenStudio::BCLMeasure.load(measure_dir)
      fail "Cannot load measure at #{measure_dir}" if measure.empty?
      measure = measure.get

      class_name = measure.className
      measure_instance_type = measure.measureType

      # Ensure that measures are in order, i.e. no OS after E+, E+ or OS after Reporting
      if measure_instance_type == 'ModelMeasure'.to_MeasureType
        fail "OpenStudio measure #{measure_dir} called after transition to EnergyPlus." if state == 'EnergyPlusMeasure'.to_MeasureType
        fail "OpenStudio measure #{measure_dir} called after after Energyplus simulation." if state == 'ReportingMeasure'.to_MeasureType
      elsif measure_instance_type == "EnergyPlusMeasure".to_MeasureType
        state = 'EnergyPlusMeasure'.to_MeasureType if state == 'ModelMeasure'.to_MeasureType
        fail "EnergyPlus measure #{measure_dir} called after Energyplus simulation." if state == 'ReportingMeasure'.to_MeasureType
      elsif measure_instance_type == 'ReportingMeasure'.to_MeasureType
        state = 'ReportingMeasure'.to_MeasureType if state != 'ReportingMeasure'.to_MeasureType
      else
        fail "Error: MeasureType #{measure_instance_type.valueName} of measure #{measure_dir} is not supported"
      end

      logger.debug "Validated step #{index}"
    end
  end
end