honeybee_ph.foundations module

PH Foundation Objects.

class honeybee_ph.foundations.PhFoundation[source]

Bases: _Base

ToString()[source]
base_attrs_from_dict(_obj: PhFoundation, _input_dict: dict) → None[source]

Set the base object attributes from a dictionary

Arguments:

  • _obj (PhFoundation): The PH Foundation object to set the attributes of.

  • _input_dict (dict): The dictionary to get the attribute values from.

Returns:

  • None

duplicate() → PhFoundation[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → PhFoundation[source]
set_base_attrs_from_source(_source)
to_dict() → Dict[str, Any][source]
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
property identifier_short
class honeybee_ph.foundations.PhFoundationFactory[source]

Bases: object

Factory class to build any PhFoundation from an input dictionary.

classmethod from_dict(_input_dict: Dict[str, Any]) → PhFoundation[source]
type_map = {'1-HEATED_BASEMENT': <class 'honeybee_ph.foundations.PhHeatedBasement'>, '2-UNHEATED_BASEMENT': <class 'honeybee_ph.foundations.PhUnheatedBasement'>, '3-SLAB_ON_GRADE': <class 'honeybee_ph.foundations.PhSlabOnGrade'>, '4-VENTED_CRAWLSPACE': <class 'honeybee_ph.foundations.PhVentedCrawlspace'>, '5-NONE': <class 'honeybee_ph.foundations.PhFoundation'>}
class honeybee_ph.foundations.PhFoundationType(_value: str | int = 1)[source]

Bases: CustomEnum

ToString()
classmethod from_dict(_dict: dict[str, Any]) → CustomEnum
to_dict() → dict[str, Any]
allowed: list[str] = ['1-HEATED_BASEMENT', '2-UNHEATED_BASEMENT', '3-SLAB_ON_GRADE', '4-VENTED_CRAWLSPACE', '5-NONE']
property allowed_upper: list[str]
property number: int

Returns the index pos of self.value (usually 1-based)

property value: str
class honeybee_ph.foundations.PhHeatedBasement[source]

Bases: PhFoundation

ToString()
base_attrs_from_dict(_obj: PhFoundation, _input_dict: dict) → None

Set the base object attributes from a dictionary

Arguments:

  • _obj (PhFoundation): The PH Foundation object to set the attributes of.

  • _input_dict (dict): The dictionary to get the attribute values from.

Returns:

  • None

duplicate() → PhHeatedBasement[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → PhHeatedBasement[source]
set_base_attrs_from_source(_source)
to_dict() → Dict[str, Any][source]
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
property identifier_short
class honeybee_ph.foundations.PhSlabEdgeInsulationPosition(_value: str | int = 1)[source]

Bases: CustomEnum

ToString()
classmethod from_dict(_dict: dict[str, Any]) → CustomEnum
to_dict() → dict[str, Any]
allowed: list[str] = ['1-UNDEFINED', '2-HORIZONTAL', '3-VERTICAL']
property allowed_upper: list[str]
property number: int

Returns the index pos of self.value (usually 1-based)

property value: str
class honeybee_ph.foundations.PhSlabOnGrade[source]

Bases: PhFoundation

ToString()
base_attrs_from_dict(_obj: PhFoundation, _input_dict: dict) → None

Set the base object attributes from a dictionary

Arguments:

  • _obj (PhFoundation): The PH Foundation object to set the attributes of.

  • _input_dict (dict): The dictionary to get the attribute values from.

Returns:

  • None

duplicate() → PhSlabOnGrade[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → PhSlabOnGrade[source]
set_base_attrs_from_source(_source)
to_dict() → Dict[str, Any][source]
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
property identifier_short
property perim_insulation_position
class honeybee_ph.foundations.PhUnheatedBasement[source]

Bases: PhFoundation

ToString()
base_attrs_from_dict(_obj: PhFoundation, _input_dict: dict) → None

Set the base object attributes from a dictionary

Arguments:

  • _obj (PhFoundation): The PH Foundation object to set the attributes of.

  • _input_dict (dict): The dictionary to get the attribute values from.

Returns:

  • None

duplicate() → PhUnheatedBasement[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → PhUnheatedBasement[source]
set_base_attrs_from_source(_source)
to_dict() → Dict[str, Any][source]
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
property identifier_short
class honeybee_ph.foundations.PhVentedCrawlspace[source]

Bases: PhFoundation

ToString()
base_attrs_from_dict(_obj: PhFoundation, _input_dict: dict) → None

Set the base object attributes from a dictionary

Arguments:

  • _obj (PhFoundation): The PH Foundation object to set the attributes of.

  • _input_dict (dict): The dictionary to get the attribute values from.

Returns:

  • None

duplicate() → PhVentedCrawlspace[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → PhVentedCrawlspace[source]
set_base_attrs_from_source(_source)
to_dict() → Dict[str, Any][source]
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
property identifier_short