Class: Honeybee::EnergyWindowMaterialBlind

Inherits:
ModelObject
  • Object
show all
Defined in:
lib/honeybee/material/window_blind.rb,
lib/to_openstudio/material/window_blind.rb,
lib/from_openstudio/material/window_blind.rb

Instance Attribute Summary

Attributes inherited from ModelObject

#errors, #openstudio_object, #warnings

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ModelObject

#allowable_types, clean_identifier, clean_name, #initialize, #method_missing, read_from_disk, truncate

Constructor Details

This class inherits a constructor from Honeybee::ModelObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Honeybee::ModelObject

Class Method Details

.from_material(material) ⇒ Object 



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
 
# File 'lib/from_openstudio/material/window_blind.rb', line 38

def self.from_material(material)
    # create an empty hash
    hash = {}
    hash[:type] = 'EnergyWindowMaterialBlind'
    # set hash values from OpenStudio Object
    hash[:identifier] = clean_name(material.nameString)
    unless material.displayName.empty?
      hash[:display_name] = (material.displayName.get).force_encoding("UTF-8")
    end
    hash[:slat_orientation] = material.slatOrientation
    hash[:slat_width] = material.slatWidth
    hash[:slat_separation] = material.slatSeparation
    hash[:slat_thickness] = material.slatThickness
    hash[:slat_width] = material.slatWidth
    hash[:slat_angle] = material.slatAngle
    hash[:slat_conductivity] = material.slatConductivity
    hash[:beam_solar_transmittance] = material.slatBeamSolarTransmittance
    hash[:beam_solar_reflectance] = material.frontSideSlatBeamSolarReflectance
    hash[:beam_solar_reflectance_back] = material.backSideSlatBeamSolarReflectance
    hash[:diffuse_solar_reflectance] = material.frontSideSlatDiffuseSolarReflectance
    hash[:diffuse_solar_reflectance_back] = material.backSideSlatDiffuseSolarReflectance
    hash[:diffuse_visible_transmittance] = material.slatDiffuseVisibleTransmittance
    # check if boost optional object is empty
    unless material.frontSideSlatDiffuseVisibleReflectance.nil?
        hash[:diffuse_visible_reflectance] = material.frontSideSlatDiffuseVisibleReflectance.get
    end
    # check if boost optional object is empty
    unless material.backSideSlatDiffuseVisibleReflectance.nil?
        hash[:diffuse_visible_reflectance_back] = material.backSideSlatDiffuseVisibleReflectance.get
    end
    hash[:infrared_transmittance] = material.slatInfraredHemisphericalTransmittance
    hash[:emissivity] = material.frontSideSlatInfraredHemisphericalEmissivity
    hash[:emissivity_back] = material.backSideSlatInfraredHemisphericalEmissivity
    hash[:distance_to_glass] = material.blindtoGlassDistance
    hash[:top_opening_multiplier] = material.blindTopOpeningMultiplier
    hash[:bottom_opening_multiplier] = material.blindBottomOpeningMultiplier
    hash[:left_opening_multiplier] = material.blindLeftSideOpeningMultiplier
    hash[:right_opening_multiplier] = material.blindRightSideOpeningMultiplier

    hash
end

Instance Method Details

#defaults ⇒ Object 



37
38
39
 
# File 'lib/honeybee/material/window_blind.rb', line 37

def defaults
  @@schema[:components][:schemas][:EnergyWindowMaterialBlind][:properties]
end

#find_existing_openstudio_object(openstudio_model) ⇒ Object 



39
40
41
42
43
 
# File 'lib/to_openstudio/material/window_blind.rb', line 39

def find_existing_openstudio_object(openstudio_model)
  object = openstudio_model.getBlindByName(@hash[:identifier])
  return object.get if object.is_initialized
  nil
end

#to_openstudio(openstudio_model) ⇒ Object 



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
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
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/to_openstudio/material/window_blind.rb', line 45

def to_openstudio(openstudio_model)
  # create blind OpenStudio object
  os_blind = OpenStudio::Model::Blind.new(openstudio_model)
  os_blind.setName(@hash[:identifier])
  unless @hash[:display_name].nil?
    os_blind.setDisplayName(@hash[:display_name])
  end
  # assign slat orientation
  if @hash[:slat_orientation]
    os_blind.setSlatOrientation(@hash[:slat_orientation])
  else
    os_blind.setSlatOrientation(defaults[:slat_orientation][:default])
  end

  # assign slat width
  if @hash[:slat_width]
    os_blind.setSlatWidth(@hash[:slat_width])
  else
    os_blind.setSlatWidth(defaults[:slat_width][:default])
  end

  # assign slat separation if it exists
  if @hash[:slat_separation]
    os_blind.setSlatSeparation(@hash[:slat_separation])
  else
    os_blind.setSlatSeparation(defaults[:slat_separation][:default])
  end

  # assign slat thickness if it exists
  if @hash[:slat_thickness]
    os_blind.setSlatThickness(@hash[:slat_thickness])
  else
    os_blind.setSlatThickness(defaults[:slat_thickness][:default])
  end

  # assign slat angle if it exists
  if @hash[:slat_angle]
    os_blind.setSlatAngle(@hash[:slat_angle])
  else
    os_blind.setSlatAngle(defaults[:slat_angle][:default])
  end

  # assign slat conductivity if it exists
  if @hash[:slat_conductivity]
    os_blind.setSlatConductivity(@hash[:slat_conductivity])
  else
    os_blind.setSlatConductivity(defaults[:slat_conductivity][:default])
  end

  # assign beam solar transmittance if it exists
  if @hash[:beam_solar_transmittance]
    os_blind.setSlatBeamSolarTransmittance(@hash[:beam_solar_transmittance])
  else
    os_blind.setSlatBeamSolarTransmittance(defaults[:beam_solar_transmittance][:default])
  end

  # assign beam solar reflectance front if it exists
  if @hash[:beam_solar_reflectance]
    os_blind.setFrontSideSlatBeamSolarReflectance(@hash[:beam_solar_reflectance])
  else
    os_blind.setFrontSideSlatBeamSolarReflectance(
      defaults[:beam_solar_reflectance][:default])
  end

  # assign beam solar reflectance back
  if @hash[:beam_solar_reflectance_back]
    os_blind.setBackSideSlatBeamSolarReflectance(@hash[:beam_solar_reflectance_back])
  else
    os_blind.setBackSideSlatBeamSolarReflectance(
      defaults[:beam_solar_reflectance_back][:default])
  end

  # assign diffuse solar transmittance
  if @hash[:diffuse_solar_transmittance]
    os_blind.setSlatDiffuseSolarTransmittance(@hash[:diffuse_solar_transmittance])
  else
    os_blind.setSlatDiffuseSolarTransmittance(
      defaults[:diffuse_solar_transmittance][:default])
  end

  # assign front diffuse solar reflectance
  if @hash[:diffuse_solar_reflectance]
    os_blind.setFrontSideSlatDiffuseSolarReflectance(@hash[:diffuse_solar_reflectance])
  else
    os_blind.setFrontSideSlatDiffuseSolarReflectance(
      defaults[:diffuse_solar_reflectance][:default])
  end

  # assign back diffuse solar reflectance
  if @hash[:diffuse_solar_reflectance_back]
    os_blind.setBackSideSlatDiffuseSolarReflectance(@hash[:diffuse_solar_reflectance_back])
  else
    os_blind.setBackSideSlatDiffuseSolarReflectance(
      defaults[:diffuse_solar_reflectance_back][:default])
  end

  # assign front diffuse visible transmittance
  if @hash[:diffuse_visible_transmittance]
    os_blind.setSlatDiffuseVisibleTransmittance(@hash[:diffuse_visible_transmittance])
  else
    os_blind.setSlatDiffuseVisibleTransmittance(
      defaults[:diffuse_visible_transmittance][:default])
  end

  # assign front diffuse visible reflectance
  if @hash[:diffuse_visible_reflectance]
    os_blind.setFrontSideSlatDiffuseVisibleReflectance(@hash[:diffuse_visible_reflectance])
  else
    os_blind.setFrontSideSlatDiffuseVisibleReflectance(
      defaults[:diffuse_visible_reflectance][:default])
  end

  # assign back diffuse visible reflectance
  if @hash[:diffuse_visible_reflectance_back]
    os_blind.setBackSideSlatDiffuseVisibleReflectance(@hash[:diffuse_visible_reflectance_back])
  else
    os_blind.setBackSideSlatDiffuseVisibleReflectance(
      defaults[:diffuse_visible_reflectance_back][:default])
  end

  # assign front beam visible transmittance
  if @hash[:beam_visible_transmittance]
    os_blind.setSlatBeamVisibleTransmittance(@hash[:beam_visible_transmittance])
  else
    os_blind.setSlatBeamVisibleTransmittance(
      defaults[:beam_visible_transmittance][:default])
  end

  # assign front beam visible reflectance
  if @hash[:beam_visible_reflectance]
    os_blind.setFrontSideSlatBeamVisibleReflectance(@hash[:beam_visible_reflectance])
  else
    os_blind.setFrontSideSlatBeamVisibleReflectance(
      defaults[:beam_visible_reflectance][:default])
  end

  # assign back beam visible reflectance
  if @hash[:beam_visible_reflectance_back]
    os_blind.setBackSideSlatBeamVisibleReflectance(@hash[:beam_visible_reflectance_back])
  else
    os_blind.setBackSideSlatBeamVisibleReflectance(
      defaults[:beam_visible_reflectance_back][:default])
  end

  # assign infrared transmittance
  if @hash[:infrared_transmittance]
    os_blind.setSlatInfraredHemisphericalTransmittance(@hash[:infrared_transmittance])
  else
    os_blind.setSlatInfraredHemisphericalTransmittance(
      defaults[:infrared_transmittance][:default])
  end

  # assign front side emissivity
  if @hash[:emissivity]
    os_blind.setFrontSideSlatInfraredHemisphericalEmissivity(@hash[:emissivity])
  else
    os_blind.setFrontSideSlatInfraredHemisphericalEmissivity(
      defaults[:emissivity][:default])
  end

  # assign back side emissivity
  if @hash[:emissivity_back]
    os_blind.setBackSideSlatInfraredHemisphericalEmissivity(@hash[:emissivity_back])
  else
    os_blind.setBackSideSlatInfraredHemisphericalEmissivity(
      defaults[:emissivity_back][:default])
  end

  # assign distance to glass
  if @hash[:distance_to_glass]
    os_blind.setBlindtoGlassDistance(@hash[:distance_to_glass])
  else
    os_blind.setBlindtoGlassDistance(defaults[:distance_to_glass][:default])
  end

  # assign top opening multiplier
  if @hash[:top_opening_multiplier]
    os_blind.setBlindTopOpeningMultiplier(@hash[:top_opening_multiplier])
  else
    os_blind.setBlindTopOpeningMultiplier(
      defaults[:top_opening_multiplier][:default])
  end

  # assign bottom opening multiplier
  if @hash[:bottom_opening_multiplier]
    os_blind.setBlindBottomOpeningMultiplier(@hash[:bottom_opening_multiplier])
  else
    os_blind.setBlindBottomOpeningMultiplier(
      defaults[:bottom_opening_multiplier][:default])
  end

  # assign left opening multiplier
  if @hash[:left_opening_multiplier]
    os_blind.setBlindLeftSideOpeningMultiplier(@hash[:left_opening_multiplier])
  else
    os_blind.setBlindLeftSideOpeningMultiplier(
      defaults[:left_opening_multiplier][:default])
  end

  # assign right opening multiplier
  if @hash[:right_opening_multiplier]
    os_blind.setBlindRightSideOpeningMultiplier(@hash[:right_opening_multiplier])
  else
    os_blind.setBlindRightSideOpeningMultiplier(
      defaults[:right_opening_multiplier][:default])
  end

  os_blind
end