PropertyHelper

implementation of the property helper

Functions:

• add_property –

  Add a property to the building element

• create_property –

  create a property

• create_ctrl_property –

  create a property

• create_param_and_ctrl_prop –

  create a property and a control property

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:

• ParameterProperty –

  created property

create_property

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

create a property

Parameters:

• name (str) –

  name of the modified property

• value_type (str) –

  value type of the property

• value (Any) –

  value of the property

Returns:

• ParameterProperty –

  created property

create_ctrl_property

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

create a property

Parameters:

• text (str) –

  control text

• name (str) –

  name of the property

Returns:

• ControlProperties –

  created property

create_param_and_ctrl_prop

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:

• text (str) –

  description

• name (str) –

  name of the modified property

• value (Any) –

  value of the property

• value_type (str) –

  value type of the property

Returns:

• Tuple[ParameterProperty, ControlProperties] –

  created property

Placeholder