Class: AssignSpaceTypeBySpaceName

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/measures/AssignSpaceTypeBySpaceName/measure.rb', line 24

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

  # make an argument for your name
  search_string = OpenStudio::Measure::OSArgument.makeStringArgument('search_string', true)
  search_string.setDisplayName('String ot search for in space names.')
  args << search_string

  # make a choice argument for model objects
  space_type_handles = OpenStudio::StringVector.new
  space_type_display_names = OpenStudio::StringVector.new

  # putting model object and names into hash
  space_type_args = model.getSpaceTypes
  space_type_args_hash = {}
  space_type_args.each do |space_type_arg|
    space_type_args_hash[space_type_arg.name.to_s] = space_type_arg
  end

  # looping through sorted hash of model objects
  space_type_args_hash.sort.map do |key, value|
    space_type_handles << value.handle.to_s
    space_type_display_names << key
  end

  # add building to string vector with space type
  building = model.getBuilding
  space_type_handles << building.handle.to_s
  space_type_display_names << '<clear field>'

  # make a choice argument for space type
  space_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('space_type', space_type_handles, space_type_display_names)
  space_type.setDisplayName('Space type to assign to affected spaces.')
  space_type.setDefaultValue('<clear field>') # if no space type is chosen this field will be cleared out
  args << space_type

  # make an argument for deleting all existing space shading in the model
  skip_already_assigned = OpenStudio::Measure::OSArgument.makeBoolArgument('skip_already_assigned', true)
  skip_already_assigned.setDisplayName('Skip spaces that already have hard assigned space types.')
  skip_already_assigned.setDefaultValue(false)
  args << skip_already_assigned

  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/AssignSpaceTypeBySpaceName/measure.rb', line 19

def name
  return 'AssignSpaceTypeBySpaceName'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/measures/AssignSpaceTypeBySpaceName/measure.rb', line 70

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
  search_string = runner.getStringArgumentValue('search_string', user_arguments)
  object = runner.getOptionalWorkspaceObjectChoiceValue('space_type', user_arguments, model)
  skip_already_assigned = runner.getBoolArgumentValue('skip_already_assigned', user_arguments)

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

  # check space type for reasonableness
  clear_field = false
  space_type = nil
  if object.empty?
    handle = runner.getStringArgumentValue('space_type', user_arguments)
    if handle.empty?
      runner.registerError('No space type was chosen.')
    else
      runner.registerError("The selected space type with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
    end
    return false
  else
    if !object.get.to_SpaceType.empty?
      space_type = object.get.to_SpaceType.get
    elsif !object.get.to_Building.empty?
      clear_field = true
    else
      runner.registerError('Script Error - argument not showing up as space type or building.')
      return false
    end
  end

  # counters
  stringMatch = 0
  spacesChanged = 0

  spaces = model.getSpaces
  spaces.each do |space|
    # get current space type
    startingSpaceType = space.spaceType

    # test string
    if space.name.to_s.include? search_string
      stringMatch += 1

      # check starting space type and user bool
      if !(skip_already_assigned && !startingSpaceType.empty?)
        spacesChanged += 1
        space.setSpaceType(space_type)
      end
    end
  end

  # reporting initial condition of model
  runner.registerInitialCondition("#{stringMatch} space names contained the requested string.")

  # reporting final condition of model
  runner.registerFinalCondition("Changed space type assignment for #{spacesChanged} spaces.")

  return true
end