PropertyHelper

implementation of the property helper

Functions:

add_property

add_property(
    build_ele: BuildingElement,
    name: str,
    value_type: str,
    value: Any,
    persist: Persistent,
) -> ParameterProperty

Add a property to the building element

Parameters:

build_ele (BuildingElement) –

building element with the parameter properties
name (str) –

name of the modified property
value_type (str) –

value type of the property
value (Any) –

value of the property
persist (Persistent) –

persistent state of the property

Returns:

create_property(name: str, value: Any, value_type: str) -> ParameterProperty

create a property

Parameters:

Returns:

create_ctrl_property(text: str, name: str) -> ControlProperties

create a property

Parameters:

Returns:

create_param_and_ctrl_prop(
    text: str, name: str, value: Any, value_type: str
) -> Tuple[ParameterProperty, ControlProperties]

create a property and a control property

Parameters:

Returns: