BuildingElementListService

class BuildingElementListService.BuildingElementListService

Bases: object

Implementation of functions for managing the data in a list of BuildingElements

static get_hash(build_ele_list: List[BuildingElement])

Calculate a hash value for script name and parameter list

Parameters

elements (build_ele_list List with the building) –

Returns

Calculated hash string.

static get_params_list(build_ele_list: List[BuildingElement],
                persistence: Persistent = Persistent.MODEL,
                exclude_parameter_names: Optional[List[str]] = None)

Get the parameter list of the building elements

Parameters

elements (build_ele_list List with the building) –

Returns

Parameter list

static migrate_fav_data(fav_param_list: List[str],
                 build_ele_list: List[BuildingElement],
                 script: Any)

Migrate the favorite data

Parameters

  • data (fav_param_list List with the parameter) –

  • elements (build_ele_list List with the building) –

static read_fav_data(fav_param_list: List[str],
              build_ele_list: List[BuildingElement],
              persistence: Persistent = Persistent.MODEL,
              is_modification_mode: bool = True,
              script: Optional[Any] = None)

Read the data from a favorite parameter list

Parameters

  • parameter (fav_param_list List with the favorite) –

  • elements (build_ele_list List with the building) –

  • persistency (persistence Parameter) –

  • read (for which the data should be) –

  • modification (is_modification_mode Read the data for the PythonPart) –

  • True/False –

static read_from_default_favorite_file(build_ele_list: List[BuildingElement])

The parameter values are read from the default favorite file and assigned to the parameters in build_ele_list. The file is located in the Allplan “…/usr/local/tmp” directory and the extension of the file is “pyv”

Parameters

elements (build_ele_list List with the building) –

static read_from_file(file_name: str,
               build_ele_list: List[BuildingElement])

Read the properties from a file

Parameters

  • file (file_name Name of the) –

  • elements (build_ele_list List with the building) –

static reset_param_values(build_ele_list: List[BuildingElement])

Reset to original parameter values from pyp file

Parameters

elements (build_ele_list List with the building) –

static write_to_default_favorite_file(build_ele_list: List[BuildingElement])

The parameter values are taken from build_ele_list and written to the default favorite file. The file is located in the Allplan “…/usr/local/tmp” directory and the extension of the file is “pyv”

Parameters

elements (build_ele_list List with the building) –

static write_to_file(file_name: str,
              build_ele_list: List[BuildingElement])

Write the properties to a file

Parameters

  • file (file_name Name of the) –

  • elements (build_ele_list List with the building) –

__module__ = 'BuildingElementListService'