List Controller

Tabular list exports for production and quantity takeoff.

Generates the structured lists used in fabrication and project management: production lists, part lists, and cover (wall / roof / floor) lists, with optional external settings files to control formatting and content. Concerned with aggregated tabular data about the model, not with geometric or drawing exports.

check_position_numbers_part_list() -> list[ElementId]

Checks the part list numbers and returns the element IDs that have discrepancies.

Returns:

Type	Description
list[ElementId]	The element IDs with discrepancies.

check_position_numbers_production_list() -> list[ElementId]

Checks the production list numbers and returns the element IDs that have discrepancies.

Returns:

Type	Description
list[ElementId]	The element IDs with discrepancies.

clear_errors() -> None

Clears all errors.

export_cover_list(element_id_list: list[ElementId], file_path: str) -> None

Exports a Wall, Roof, or Floor list to the specified file path.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of element IDs to be exported.	required
file_path	str	The path of the target file for the export.	required

export_cover_list_with_settings(element_id_list: list[ElementId], file_path: str, settings_file_path: str) -> None

Exports a Wall, Roof, or Floor list to the specified file path using an additional settings file.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of element IDs to be exported.	required
file_path	str	The path of the target file for the export.	required
settings_file_path	str	The path to the settings file to be used for export.	required

export_part_list(element_id_list: list[ElementId], file_path: str) -> None

Exports a part list to the specified file path.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of element IDs to be exported.	required
file_path	str	The path of the target file for the export.	required

export_part_list_with_settings(element_id_list: list[ElementId], file_path: str, settings_file_path: str) -> None

Exports a part list using an additional settings file.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of element IDs to be exported.	required
file_path	str	The path of the target file for the export.	required
settings_file_path	str	The path to the settings file to be used for export.	required

export_production_list(element_id_list: list[ElementId], file_path: str) -> None

Exports a production list to the given file path.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of element IDs to be exported.	required
file_path	str	The path of the target file for the export.	required

export_production_list_with_settings(element_id_list: list[ElementId], file_path: str, settings_file_path: str) -> None

Exports a production list using an additional settings file.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of element IDs to be exported.	required
file_path	str	The path of the target file for the export.	required
settings_file_path	str	The path to the settings file to be used for export.	required

generate_new_part_list_numbers(element_id_list: list[ElementId]) -> None

Generates new part list numbers for the specified elements.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of elements to generate numbers for.	required

generate_new_part_list_silently(element_id_list: list[ElementId], starting_number: UnsignedInt, keep_existing_numbers: bool, with_containers: bool) -> None

Generates new part list numbers silently starting from a given number, optionally keeping existing numbers and considering container elements.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of elements to generate numbers for.	required
starting_number	UnsignedInt	The number from which to start assigning new numbers.	required
keep_existing_numbers	bool	Whether or not to retain already assigned numbers in the list.	required
with_containers	bool	Whether to include container elements in the number generation.	required

generate_new_production_list_numbers(element_id_list: list[ElementId]) -> None

Generates new production list numbers for the specified elements.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of elements to generate numbers for.	required

generate_new_production_list_silently(element_id_list: list[ElementId], starting_number: UnsignedInt, keep_existing_numbers: bool, with_containers: bool) -> None

Generates new production list numbers silently starting from a given number, optionally keeping existing numbers and considering container elements.

Parameters:

Name	Type	Description	Default
element_id_list	list[ElementId]	The list of elements to generate numbers for.	required
starting_number	UnsignedInt	The number from which to start assigning new numbers.	required
keep_existing_numbers	bool	Whether or not to retain already assigned numbers in the list.	required
with_containers	bool	Whether to include container elements in the number generation.	required

load_part_list_calculation_settings(settings_file_path: str) -> None

Loads the part list calculation settings from a file.

Parameters:

Name	Type	Description	Default
settings_file_path	str	The path to the settings file to be loaded.	required

load_production_list_calculation_settings(settings_file_path: str) -> None

Loads the production list calculation settings from a file.

Parameters:

Name	Type	Description	Default
settings_file_path	str	The path to the settings file to be loaded.	required