class URBANopt::Reporting::DefaultReports::EndUse

Enduse class all enduse energy consumption results.

Public Class Methods

new(hash = {}) click to toggle source

EndUse class intialize all enduse atributes: :heating , :cooling , :interior_lighting , :exterior_lighting , :interior_equipment , :exterior_equipment , :fans , :pumps , :heat_rejection , :humidification , :heat_recovery , :water_systems , :refrigeration , :generators

parameters:: hash - Hash - A hash which may contain a deserialized end_use.

# File lib/urbanopt/reporting/default_reports/end_use.rb, line 27
def initialize(hash = {})
  hash.delete_if { |k, v| v.nil? }
  hash = defaults.merge(hash)

  @heating = hash[:heating]
  @cooling = hash[:cooling]
  @interior_lighting = hash[:interior_lighting]
  @exterior_lighting = hash[:exterior_lighting]
  @interior_equipment = hash[:interior_equipment]
  @exterior_equipment = hash[:exterior_equipment]
  @electric_vehicles = hash[:electric_vehicles]
  @fans = hash[:fans]
  @pumps = hash[:pumps]
  @heat_rejection = hash[:heat_rejection]
  @humidification = hash[:humidification]
  @heat_recovery = hash[:heat_recovery]
  @water_systems = hash[:water_systems]
  @refrigeration = hash[:refrigeration]
  @generators = hash[:generators]

  # initialize class variables @@validator and @@schema
  @@validator ||= Validator.new
  @@schema ||= @@validator.schema
end

Public Instance Methods

add_values(existing_value, new_value) click to toggle source

Adds up existing_value and new_values if not nill.

parameter:

existing_value - Float - A value corresponding to a EndUse attribute.

new_value - Float - A value corresponding to a EndUse attribute.

# File lib/urbanopt/reporting/default_reports/end_use.rb, line 118
def add_values(existing_value, new_value)
  if existing_value && new_value
    existing_value += new_value
  elsif new_value
    existing_value = new_value
  end
  return existing_value
end

defaults() click to toggle source

Assign default values if values does not exist

# File lib/urbanopt/reporting/default_reports/end_use.rb, line 55
def defaults
  hash = {}

  hash[:heating] = nil
  hash[:cooling] = nil
  hash[:interior_lighting] = nil
  hash[:exterior_lighting] = nil
  hash[:interior_equipment] = nil
  hash[:exterior_equipment] = nil
  hash[:electric_vehicles] = nil
  hash[:fans] = nil
  hash[:pumps] = nil
  hash[:heat_rejection] = nil
  hash[:humidification] = nil
  hash[:heat_recovery] = nil
  hash[:water_systems] = nil
  hash[:refrigeration] = nil
  hash[:generators] = nil

  return hash
end

merge_end_use!(other) click to toggle source

Aggregate values of each EndUse attribute.

Parameters:: other - EndUse - An object of EndUse class.

# File lib/urbanopt/reporting/default_reports/end_use.rb, line 133
def merge_end_use!(other)
  @heating = add_values(@heating, other.heating)
  @cooling = add_values(@cooling, other.cooling)
  @interior_lighting = add_values(@interior_lighting, other.interior_lighting)
  @exterior_lighting = add_values(@exterior_lighting, other.exterior_lighting)
  @interior_equipment = add_values(@interior_equipment, other.interior_equipment)
  @exterior_equipment = add_values(@exterior_equipment, other.exterior_equipment)
  @electric_vehicles = add_values(@electric_vehicles, other.electric_vehicles)
  @fans = add_values(@fans, other.fans)
  @pumps = add_values(@pumps, other.pumps)
  @heat_rejection = add_values(@heat_rejection, other.heat_rejection)
  @humidification = add_values(@humidification, other.humidification)
  @heat_recovery = add_values(@heat_recovery, other.heat_recovery)
  @water_systems = add_values(@water_systems, other.water_systems)
  @refrigeration = add_values(@refrigeration, other.refrigeration)
  @generators = add_values(@generators, other.generators)

  return self
end

to_hash() click to toggle source

Convert to a Hash equivalent for JSON serialization.

Exclude attributes with nil values.
Validate end_use hash properties against schema.

# File lib/urbanopt/reporting/default_reports/end_use.rb, line 83
def to_hash
  result = {}

  result[:heating] = @heating
  result[:cooling] = @cooling
  result[:interior_lighting] = @interior_lighting
  result[:exterior_lighting] = @exterior_lighting
  result[:interior_equipment] = @interior_equipment
  result[:exterior_equipment] = @exterior_equipment
  result[:electric_vehicles] = @electric_vehicles
  result[:fans] = @fans
  result[:pumps] = @pumps
  result[:heat_rejection] = @heat_rejection
  result[:humidification] = @humidification
  result[:heat_recovery] = @heat_recovery
  result[:water_systems] = @water_systems
  result[:refrigeration] = @refrigeration
  result[:generators] = @generators

  # validate end_use properties against schema
  if @@validator.validate(@@schema[:definitions][:EndUse][:properties], result).any?
    raise "end_use properties does not match schema: #{@@validator.validate(@@schema[:definitions][:EndUse][:properties], result)}"
  end

  return result
end