honeybee_energy_ph.construction.window module

HBPH Window Objects

class honeybee_energy_ph.construction.window.PhWindowFrame(_identifier)[source]

Bases: _Base

A full PH window frame made of 4 PhWindowFrameElements.

ToString()[source]
duplicate() → PhWindowFrame[source]
classmethod from_dict(_input_dict: dict) → PhWindowFrame[source]
set_base_attrs_from_dict(_input_dict: dict[str, Any]) → None

Set all the Base attribute values from an input dict.

set_base_attrs_from_obj(other: _Base) → None

Sets the base attributes based on another object. Used during __copy__.

to_dict() → dict[str, Any][source]

Return all the base attribute values as a dict.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property elements: List[PhWindowFrameElement]

Return all four frame elements in clockwise order from top (t, r, b, l).

property identifier

Get the text string for unique construction identifier.

property user_data: dict

Get an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)

class honeybee_energy_ph.construction.window.PhWindowFrameElement(_identifier)[source]

Bases: _Base

An individual PhWindowFrameElement (side) which is part of a complete PhWindowFrame.

ToString()[source]
duplicate() → PhWindowFrameElement[source]
classmethod from_dict(_input_dict: dict) → PhWindowFrameElement[source]
set_base_attrs_from_dict(_input_dict: dict[str, Any]) → None

Set all the Base attribute values from an input dict.

set_base_attrs_from_obj(other: _Base) → None

Sets the base attributes based on another object. Used during __copy__.

to_dict() → dict[str, Any][source]

Return all the base attribute values as a dict.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

Get the text string for unique construction identifier.

property user_data: dict

Get an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)

class honeybee_energy_ph.construction.window.PhWindowGlazing(_identifier)[source]

Bases: _Base

ToString()[source]
duplicate() → PhWindowGlazing[source]
classmethod from_dict(_input_dict: dict) → PhWindowGlazing[source]
set_base_attrs_from_dict(_input_dict: dict[str, Any]) → None

Set all the Base attribute values from an input dict.

set_base_attrs_from_obj(other: _Base) → None

Sets the base attributes based on another object. Used during __copy__.

to_dict() → dict[str, Any][source]

Return all the base attribute values as a dict.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

Get the text string for unique construction identifier.

property user_data: dict

Get an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)