Class: BTAP::EQuest::DOERoof

Inherits:

DOECommand

• Object
• DOECommand
• BTAP::EQuest::DOERoof

Defined in:

lib/openstudio-standards/btap/equest.rb

Overview

The interface for the roof command.. same as parent.

Instance Attribute Summary

Attributes inherited from DOECommand

#building, #children, #commandName, #commandType, #comments, #exempt, #keywordPairs, #non_utype_commands, #one_line_commands, #parents, #utype, #uvalue

Instance Method Summary

• #get_absolute_azimuth ⇒ Object

  OUTPUT: Azimuth between ROOF and TRUE NORTH.

• #get_area ⇒ Object

  This method finds the area of the roof.

• #get_azimuth ⇒ Object

  OUTPUT: Azimuth between the parent SPACE and the ROOF.

• #get_tilt ⇒ Object

  returns tilt of roof surface.

• #initialize ⇒ DOERoof constructor

  A new instance of DOERoof.

Methods inherited from DOECommand

#basic_output, #check_keyword?, #depth, #doe_scope, #get_children, #get_children_of_command, #get_command_from_string, #get_keyword_value, #get_name, #get_parent, #get_parents, #name, #output, #remove, #remove_keyword_pair, #set_keyword_value, #set_parent

Constructor Details

#initialize ⇒ DOERoof

Returns a new instance of DOERoof.

# File 'lib/openstudio-standards/btap/equest.rb', line 1305

def initialize
  super()
end

Instance Method Details

#get_absolute_azimuth ⇒ Object

OUTPUT: Azimuth between ROOF and TRUE NORTH

# File 'lib/openstudio-standards/btap/equest.rb', line 1445

def get_absolute_azimuth
  space = get_parent("SPACE")
  if check_keyword?("AZIMUTH")
    azimuth = get_keyword_value("AZIMUTH").to_f
    space_azimuth = space.get_absolute_azimuth
    return azimuth + space_azimuth
  else
    if check_keyword?("LOCATION")
      location = get_keyword_value("LOCATION")
      case location
      when "TOP"
        raise "Exception: Azimuth does not exist"
      when "BOTTOM"
        raise "Exception: Azimuth does not exist"
      when "FRONT"
        return 0.0 + space.get_absolute_azimuth
      when "RIGHT"
        return 90.0 + space.get_absolute_azimuth
      when "BACK"
        return 180.0 + space.get_absolute_azimuth
      when "LEFT"
        return 270.0 + space.get_absolute_azimuth
      end
    end
    if space.get_keyword_value("SHAPE") == "POLYGON"
      space_vertex = get_keyword_value("LOCATION")
      space_vertex.match(/SPACE-(.*)/)
      vertex = $1.strip
      return space.polygon.get_azimuth(vertex) + space.get_absolute_azimuth
    end
  end
end

#get_area ⇒ Object

This method finds the area of the roof

# File 'lib/openstudio-standards/btap/equest.rb', line 1310

def get_area

  # Finds the floor and space parents and assigns them to @floor and @space
  # variables to be used later
  parent = get_parents
  parent.each do |findcommand|
    if ( findcommand.commandName == "FLOOR" )
      @floor = findcommand
    end
    if ( findcommand.commandName == "SPACE")
      @space = findcommand
    end
  end

  # Get the keyword value for location
  begin
    location = get_keyword_value("LOCATION")
  rescue
  end

  # Get the keyword value for polygon
  begin
    polygon_id = get_keyword_value("POLYGON")
  rescue
  end

  # if the polygon_id keyword value was nil and the location value was nil, then
  # the height and width are directly defined within the "roof" command


  if  ( location == "BOTTOM" || location == "TOP") && (@space.get_shape != "BOX")
    return @space.polygon.get_area

  elsif ( location == nil  && polygon_id == nil )
    height = get_keyword_value("HEIGHT")
    width = get_keyword_value("WIDTH")
    height = height.to_f
    width = width.to_f
    return height * width
  elsif ( location == nil && polygon_id != nil)
    return @space.polygon.get_area


    # if the location was defined as "SPACE...", it is immediately followed by a
    # vertex, upon which lies the width of the roof
  elsif location.match(/SPACE.*/)
    location = location.sub( /^(.{6})/, "")
    width = @space.polygon.get_length(location)
    height = @floor.get_space_height
    return width * height
    # if the shape was a box, the width and height would be taken from the
    # "SPACE" object
  elsif ( @space.get_shape == "BOX" )
    width = @space.get_width
    height = @space.get_height
    return width * height
  else
    raise "The area could not be evaluated"
  end
end

#get_azimuth ⇒ Object

OUTPUT: Azimuth between the parent SPACE and the ROOF

# File 'lib/openstudio-standards/btap/equest.rb', line 1402

def get_azimuth()
  space = get_parent("SPACE")
  if check_keyword?("AZIMUTH") then return get_keyword_value("AZIMUTH").to_f
  else
    if check_keyword?("LOCATION")
      location = get_keyword_value("LOCATION")

      case location
      when "TOP"
        raise "Exception: Azimuth does not exist"
      when "BOTTOM"
        raise "Exception: Azimuth does not exist"
      when "FRONT"
        return 0.0 + space.get_azimuth
      when "RIGHT"
        return 90.0 + space.get_azimuth
      when "BACK"
        return 180.0 + space.get_azimuth
      when "LEFT"
        return 270.0 + space.get_azimuth
      end
    end
    if space.get_keyword_value("SHAPE") == "POLYGON"
      space_vertex = get_keyword_value("LOCATION")
      space_vertex.match(/SPACE-(.*)/)
      vertex = $1.strip
      return space.polygon.get_azimuth(vertex)
    end

  end
end

#get_tilt ⇒ Object

returns tilt of roof surface.

# File 'lib/openstudio-standards/btap/equest.rb', line 1372

def get_tilt()
  if check_keyword?("TILT") then return get_keyword_value("TILT").to_f
  else
    if check_keyword?("LOCATION")
      location = get_keyword_value("LOCATION")
      case location
      when "TOP"
        return 0.0
      when "BOTTOM"
        return 180.0
      when "LEFT", "RIGHT", "BACK", "FRONT"
        return 90.0
      end
    end
    # If it is a polygon or not defined, set to DOE default = 0.0
    return 0
  end
end