Class: SetInteriorWallsToSelectedConstruction

Inherits:
OpenStudio::Measure::ModelMeasure
  • Object
show all
Defined in:
lib/measures/SetInteriorWallsToSelectedConstruction/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
 
# File 'lib/measures/SetInteriorWallsToSelectedConstruction/measure.rb', line 24

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

  # populate choice argument for storys that are applied to surfaces in the model
  construction_handles = OpenStudio::StringVector.new
  construction_display_names = OpenStudio::StringVector.new

  # putting stories and names into hash
  construction_args = model.getConstructions
  construction_args_hash = {}
  construction_args.each do |construction_arg|
    construction_args_hash[construction_arg.name.to_s] = construction_arg
  end

  # looping through sorted hash of constructions
  construction_args_hash.sort.map do |key, value| # TODO: - could filter this so only constructions that are valid on opaque surfaces will show up.
    construction_handles << value.handle.to_s
    construction_display_names << key
  end

  # make an argument for construction
  construction = OpenStudio::Measure::OSArgument.makeChoiceArgument('construction', construction_handles, construction_display_names, true)
  construction.setDisplayName('Select new material:')
  args << construction

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

def name
  return 'SetInteriorWallsToSelectedConstruction'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/measures/SetInteriorWallsToSelectedConstruction/measure.rb', line 53

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
  construction = runner.getOptionalWorkspaceObjectChoiceValue('construction', user_arguments, model) # model is passed in because of argument type

  # check the construction for reasonableness
  if construction.empty?
    handle = runner.getStringArgumentValue('construction', user_arguments)
    if handle.empty?
      runner.registerError('No construction was chosen.')
    else
      runner.registerError("The selected construction with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
    end
    return false
  else
    if !construction.get.to_Construction.empty?
      construction = construction.get.to_Construction.get
    else
      runner.registerError('Script Error - argument not showing up as construction.')
      return false
    end
  end

  # counter for number of constructions use for interior walls in initial construction
  interior_walls = 0

  # change mats
  surfaces = model.getSurfaces
  surfaces.each do |surface|
    if (surface.surfaceType == 'Wall') && (surface.outsideBoundaryCondition == 'Surface')
      surface.setConstruction(construction)
      interior_walls += 1
    end
  end

  # reporting initial condition of model
  runner.registerInitialCondition("The initial model has #{interior_walls / 2} pairs of interior wall surfaces.")

  # reporting final condition of model
  finishing_spaces = model.getSpaces
  runner.registerFinalCondition("All interior walls surfaces now use #{construction.name} for the construction.")

  return true
end