Module: References

Defined in:

lib/openstudio-standards/refs/references.rb

Overview

This module defines codes, standards, reference documents, reports, and other technical resources that assumptions or methodologies in the standard are taken from. These methods perform no action, and are not used in the source code except to store reference information.

Examples:

Linking to a Reference from methods or classes

# @ref [References::ASHRAE9012004] section G.3.1, table 3
def some_method()
  ...

Defined Under Namespace

Classes: ASHRAE9012004, ASHRAE9012007, ASHRAE9012010, ASHRAE9012013, ASHRAE9012016, ASHRAE9012019, ASHRAE901PRM2019, CBERadiantSystems, CBES, DEERMASControl, ICCIECC2015, NECB2011, NRELZNEReady2017, OEESC2014, PNNLInfiltration, PNNLPRMReferenceManual2016, USDOEPrototypeBuildingEnhancements, USDOEPrototypeBuildings, USDOEReferenceBuildings, ZEAEDGMultifamily