API Reference _base

_base

Base class for Honeybee-PH Objects with some generic methods and attributes.

Source: honeybee_ph/_base.py


_Base

Base class for all Honeybee-PH model objects.

Attributes

AttributeTypeDescription
user_dataDictArbitrary user-supplied metadata dictionary.

Properties

PropertyTypeDescription
identifierstrThe globally unique identifier string for this object.
display_namestrUser-facing name for this object, without character restrictions.
identifier_shortstrThe first segment of the identifier (before the first hyphen).

Methods

set_base_attrs_from_source(_source)

Copy identifier, user_data, and display_name from another _Base instance.

ArgTypeDescription
_source_BaseThe source object to copy base attributes from.

Returns: _Base