Class: AssignSpacesToStories

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

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

  return args
end

#getStoryForNominalZCoordinate(model, minz) ⇒ Object

find the first story with z coordinate, create one if needed



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/measures/AssignSpacesToStories/measure.rb', line 42

def getStoryForNominalZCoordinate(model, minz)
  model.getBuildingStorys.each do |story|
    z = story.nominalZCoordinate
    if !z.empty? && (minz.round(2) == z.get.round(2))
      return story
    end
  end

  story = OpenStudio::Model::BuildingStory.new(model)
  story.setNominalZCoordinate(minz)
  return story
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/AssignSpacesToStories/measure.rb', line 19

def name
  return 'AssignSpacesToStories'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
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
 
# File 'lib/measures/AssignSpacesToStories/measure.rb', line 31

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

  # find the first story with z coordinate, create one if needed
  def getStoryForNominalZCoordinate(model, minz)
    model.getBuildingStorys.each do |story|
      z = story.nominalZCoordinate
      if !z.empty? && (minz.round(2) == z.get.round(2))
        return story
      end
    end

    story = OpenStudio::Model::BuildingStory.new(model)
    story.setNominalZCoordinate(minz)
    return story
  end

  # reporting initial condition of model
  starting_stories = model.getBuildingStorys
  runner.registerInitialCondition("The building started with #{starting_stories.size} stories.")

  # get all spaces
  spaces = model.getSpaces

  # make has of spaces and minz values
  sorted_spaces = {}
  spaces.each do |space|
    # loop through space surfaces to find min z value
    z_points = []
    space.surfaces.each do |surface|
      surface.vertices.each do |vertex|
        z_points << vertex.z
      end
    end
    minz = z_points.min + space.zOrigin
    sorted_spaces[space] = minz
  end

  # pre-sort spaces
  sorted_spaces = sorted_spaces.sort_by { |a| a[1] }

  # this should take the sorted list and make and assign stories
  sorted_spaces.each do |space|
    space_obj = space[0]
    space_minz = space[1]
    if space_obj.buildingStory.empty?

      story = getStoryForNominalZCoordinate(model, space_minz)
      space_obj.setBuildingStory(story)

    end
  end

  # reporting final condition of model
  finishing_stories = model.getBuildingStorys
  runner.registerFinalCondition("The building finished with #{finishing_stories.size} stories.")

  return true
end