honeybee_phhvac.hot_water_devices module

Honeybee-PH-HVAC: Hot Water Devices.

exception honeybee_phhvac.hot_water_devices.UnknownPhHvacHotWaterHeaterTypeError(_heater_types, _received_type)[source]

Bases: Exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeater[source]

Bases: _PhHVACBase

Base class for all PH Hot-Water Heaters.

ToString()[source]
duplicate() PhHvacHotWaterHeater[source]
classmethod from_dict(_input_dict: Dict[str, Any]) PhHvacHotWaterHeater[source]
to_dict(_include_properties: bool = False) dict[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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterBoiler[source]

Bases: PhHvacHotWaterHeater

ToString()
duplicate() PhHvacHotWaterHeater
classmethod from_dict(_input_dict: dict) PhHvacHotWaterHeaterBoiler[source]
to_dict(_include_properties: bool = False) dict[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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterBoilerWood[source]

Bases: PhHvacHotWaterHeater

ToString()
duplicate() PhHvacHotWaterHeater
classmethod from_dict(_input_dict: Dict[str, Any]) PhHvacHotWaterHeaterBoilerWood[source]
to_dict(_include_properties: bool = False) 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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterBuilder[source]

Bases: object

Constructor class for Hot-Water-Heater objects

ToString()[source]
classmethod from_dict(_input_dict: dict) PhHvacHotWaterHeater[source]
heaters = {'PhHvacHotWaterHeaterBoiler': <class 'honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterBoiler'>, 'PhHvacHotWaterHeaterBoilerWood': <class 'honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterBoilerWood'>, 'PhHvacHotWaterHeaterDistrict': <class 'honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterDistrict'>, 'PhHvacHotWaterHeaterElectric': <class 'honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterElectric'>, 'PhHvacHotWaterHeaterHeatPump_Annual': <class 'honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterHeatPump_Annual'>, 'PhHvacHotWaterHeaterHeatPump_Inside': <class 'honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterHeatPump_Inside'>, 'PhHvacHotWaterHeaterHeatPump_Monthly': <class 'honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterHeatPump_Monthly'>}
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterDistrict[source]

Bases: PhHvacHotWaterHeater

ToString()
duplicate() PhHvacHotWaterHeater
classmethod from_dict(_input_dict)[source]
to_dict(_include_properties: bool = False) 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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterElectric[source]

Bases: PhHvacHotWaterHeater

ToString()
duplicate() PhHvacHotWaterHeater
classmethod from_dict(_input_dict: Dict[str, Any]) PhHvacHotWaterHeaterElectric[source]
to_dict(_include_properties: bool = False) 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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterHeatPump_Annual[source]

Bases: PhHvacHotWaterHeater

ToString()
duplicate() PhHvacHotWaterHeater
classmethod from_dict(_input_dict: Dict[str, Any]) PhHvacHotWaterHeaterHeatPump_Annual[source]
to_dict(_include_properties: bool = False) 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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterHeatPump_Inside[source]

Bases: PhHvacHotWaterHeater

ToString()
duplicate() PhHvacHotWaterHeater
classmethod from_dict(_input_dict: Dict[str, Any]) PhHvacHotWaterHeaterHeatPump_Inside[source]
to_dict(_include_properties: bool = False) 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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterHeaterHeatPump_Monthly[source]

Bases: PhHvacHotWaterHeater

ToString()
duplicate() PhHvacHotWaterHeater
classmethod from_dict(_input_dict: Dict[str, Any]) PhHvacHotWaterHeaterHeatPump_Monthly[source]
to_dict(_include_properties: bool = False) 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: str
property key
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterTank[source]

Bases: _PhHVACBase

ToString()[source]
duplicate() PhHvacHotWaterTank[source]
classmethod from_dict(_input_dict: dict[str, Any]) PhHvacHotWaterTank[source]
to_dict(_include_properties: bool = False) 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: str
property key
property tank_type
class honeybee_phhvac.hot_water_devices.PhHvacHotWaterTankType(_value: str | int = 1, _index_offset: int = 0)[source]

Bases: CustomEnum

ToString()
classmethod from_dict(_dict: dict[str, Any]) CustomEnum
to_dict() dict[str, Any]
allowed: list[str] = ['0-No storage tank', '1-DHW and heating', '2-DHW only']
property allowed_upper: list[str]
property number: int

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

property value: str