Class: Honeybee::LightingAbridged

Inherits:
ModelObject show all
Defined in:
lib/honeybee/load/lighting.rb,
lib/to_openstudio/load/lighting.rb,
lib/from_openstudio/load/lighting.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_load(load) ⇒ 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
 
# File 'lib/from_openstudio/load/lighting.rb', line 38

def self.from_load(load)
    # create an empty hash
    hash = {}
    hash[:type] = 'LightingAbridged'
    # set hash values from OpenStudio Object
    hash[:identifier] = clean_name(load.nameString)
    unless load.displayName.empty?
        hash[:display_name] = (load.displayName.get).force_encoding("UTF-8")
    end
    unless load.schedule.empty?
        schedule = load.schedule.get
        hash[:schedule] = schedule.nameString
    end
    loads_def = load.lightsDefinition
    unless loads_def.wattsperSpaceFloorArea.empty?
        hash[:watts_per_area] = loads_def.wattsperSpaceFloorArea.get
    end
    #TODO: user_data?
    #TODO: baseline_watts_per_area
    hash[:visible_fraction] = loads_def.fractionVisible
    hash[:radiant_fraction] = loads_def.fractionRadiant
    hash[:return_air_fraction] = loads_def.returnAirFraction

    hash
end

Instance Method Details

#defaults ⇒ Object 



37
38
39
 
# File 'lib/honeybee/load/lighting.rb', line 37

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

#find_existing_openstudio_object(openstudio_model) ⇒ Object 



39
40
41
42
43
 
# File 'lib/to_openstudio/load/lighting.rb', line 39

def find_existing_openstudio_object(openstudio_model)
  model_lights = openstudio_model.getLightsByName(@hash[:identifier])
  return model_lights.get unless model_lights.empty?
  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
 
# File 'lib/to_openstudio/load/lighting.rb', line 45

def to_openstudio(openstudio_model)

  # create lights OpenStudio object and set identifier
  os_lights_def = OpenStudio::Model::LightsDefinition.new(openstudio_model)
  os_lights = OpenStudio::Model::Lights.new(os_lights_def)
  os_lights_def.setName(@hash[:identifier])
  unless @hash[:display_name].nil?
    os_lights_def.setDisplayName(@hash[:display_name])
  end
  os_lights.setName(@hash[:identifier])

  # assign watts per space floor area
  os_lights_def.setWattsperSpaceFloorArea(@hash[:watts_per_area])

  # assign lighting schedule
  lighting_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
  unless lighting_schedule.empty?
    lighting_schedule_object = lighting_schedule.get
    os_lights.setSchedule(lighting_schedule_object)
  end

  # assign visible fraction if it exists
  if @hash[:visible_fraction]
    os_lights_def.setFractionVisible(@hash[:visible_fraction])
  else
    os_lights_def.setFractionVisible(defaults[:visible_fraction][:default])
  end

  # assign radiant fraction if it exists
  if @hash[:radiant_fraction]
    os_lights_def.setFractionRadiant(@hash[:radiant_fraction])
  else
    os_lights_def.setFractionRadiant(defaults[:radiant_fraction][:default])
  end

  # assign return air fraction if it exists
  if @hash[:return_air_fraction]
    os_lights_def.setReturnAirFraction(@hash[:return_air_fraction])
  else
    os_lights_def.setReturnAirFraction(defaults[:return_air_fraction][:default])
  end

  os_lights
end