API Reference _base

_base

HBPH Base class for all Constructions

Source: honeybee_energy_ph/_base.py


_Base

Base class for all honeybee_energy_ph construction objects.

Attributes

AttributeTypeDescription
id_numintNumeric ID for serialization ordering.

Properties

PropertyTypeDescription
identifierGet the text string for unique construction identifier.
display_nameGet or set a string for the object name without any character restrictions.
user_datadictGet an optional dictionary for additional meta data for this object.

Methods

set_base_attrs_from_dict(_input_dict)

Set all the Base attribute values from an input dict.

ArgTypeDescription
_input_dictdict[str

Returns: None

set_base_attrs_from_obj(other)

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

ArgTypeDescription
other_Base

Returns: None