Rooms by Attribute

- [source code]

Separate and group honeybee Rooms by any attribute that the room possesses.

This can be used to group rooms by program, whether rooms are conditioned, etc.

Inputs

  • rooms [Required]

An array of honeybee Rooms or honeybee Models to be separated and grouped based on their attributes.

  • attribute [Required]

Text for the name of the Room attribute with which the Rooms should be labeled. The Honeybee "Room Attributes" component lists all of the core attributes of the room. Also, each Honeybee extension (ie. Radiance, Energy) includes its own component that lists the Room attributes of that extension.

  • value

An optional value of the attribute that can be used to filter the output rooms. For example, if the input attribute is "Program" a value for the name of a program can be plugged in here (eg. "2019::LargeOffice::OpenOffice") in order to get only the rooms that have this program assigned.

Outputs

  • values

A list of values with one attribute value for each branch of the output rooms.

  • rooms

A data tree of honeybee rooms with each branch of the tree representing a different attribute value.

Last updated