Class: FindAndReplaceInAllThermalZoneNames

Inherits:
OpenStudio::Measure::ModelMeasure
  • Object
show all
Defined in:
lib/measures/find_and_replace_in_all_thermal_zone_names/measure.rb

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input define the arguments that the user will input



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/measures/find_and_replace_in_all_thermal_zone_names/measure.rb', line 25

def arguments(model)
  args = OpenStudio::Measure::OSArgumentVector.new

  # make an argument for your name
  orig_string = OpenStudio::Measure::OSArgument.makeStringArgument('orig_string', true)
  orig_string.setDisplayName('Type the text you want search for in thermal zone names')
  orig_string.setDefaultValue(' Thermal Zone')
  args << orig_string

  # make an argument to add new space true/false
  new_string = OpenStudio::Measure::OSArgument.makeStringArgument('new_string', true)
  new_string.setDisplayName('Type the text you want to add in place of the found text')
  new_string.setDefaultValue('')
  args << new_string

  return args
end

#name ⇒ Object

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



19
20
21
 
# File 'lib/measures/find_and_replace_in_all_thermal_zone_names/measure.rb', line 19

def name
  return 'Find And Replace In All Thermal Zone Names'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



44
45
46
47
48
49
50
51
52
53
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
 
# File 'lib/measures/find_and_replace_in_all_thermal_zone_names/measure.rb', line 44

def run(model, runner, user_arguments)
  super(model, runner, user_arguments)

  # use the built-in error checking
  if !runner.validateUserArguments(arguments(model), user_arguments)
    return false
  end

  # assign the user inputs to variables
  orig_string = runner.getStringArgumentValue('orig_string', user_arguments)
  new_string = runner.getStringArgumentValue('new_string', user_arguments)

  # check the orig_string for reasonableness
  puts orig_string
  if orig_string == ''
    runner.registerError('No search string was entered.')
    return false
  end

  # reporting initial condition of model
  thermal_zones = model.getThermalZones
  runner.registerInitialCondition("The model has #{thermal_zones.size} thermal zones.")

  # array for objects with names
  named_objects = []

  # loop through model objects and rename if the object has a name
  thermal_zones.each do |thermal_zone|
    if thermal_zone.name.is_initialized
      old_name = thermal_zone.name.get
      requested_name = old_name.gsub(orig_string, new_string)
      new_name = thermal_zone.setName(requested_name)
      if old_name != new_name
        named_objects << new_name
      elsif old_name != requested_name
        runner.registerWarning("Could not change name of '#{old_name}' to '#{requested_name}'.")
      end
    end
  end

  # reporting final condition of model
  runner.registerFinalCondition("#{named_objects.size} thermal zones were renamed.")

  return true
end