List Controller

interface ICwAPI3DListController

Public Functions

virtual ICwAPI3DString *getLastError(int32_t *aErrorCode) = 0

Gets the last error.

Parameters:

aErrorCode – [out] [int32_t*] The error code.

Returns:

[ICwAPI3DString*] The error string.

virtual void exportProductionList(ICwAPI3DElementIDList *aElementIdList, const character *aExportFilePath) = 0

Exports a production list.

Parameters:
virtual void exportPartList(ICwAPI3DElementIDList *aElementIdList, const character *aExportFilePath) = 0

Exports a part list.

Parameters:
virtual ICwAPI3DElementIDList *checkPositionNumbersProductionList() = 0

Checks the production list numbers and returns the element id list with discrepancies.

Returns:

[ICwAPI3DElementIDList*] The element id list with discrepancies.

virtual ICwAPI3DElementIDList *checkPositionNumbersPartList() = 0

Checks the part list numbers and returns the element id list with discrepancies.

Returns:

[ICwAPI3DElementIDList*] The element id list with discrepancies.

virtual void clearErrors() = 0

Clears all errors.

virtual void exportProductionListWithSettings(ICwAPI3DElementIDList *aElementIdList, const character *aExportFilePath, const character *aSettingsFilePath) = 0

Exports a production list with settings file.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element list id.

  • aExportFilePath – [in] [const character*] The exported file path.

  • aSettingsFilePath – [in] [const character*] The settings file path.

virtual void exportPartListWithSettings(ICwAPI3DElementIDList *aElementIdList, const character *aExportFilePath, const character *aSettingsFilePath) = 0

Exports a part list with settings file.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element list id.

  • aExportFilePath – [in] [const character*] The exported file path.

  • aSettingsFilePath – [in] [const character*] The settings file path.

virtual void generateNewNumbersProductionList(ICwAPI3DElementIDList *aElementIdList) = 0

Generates new numbers for production list.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element list id.

virtual void generateNewNumbersPartList(ICwAPI3DElementIDList *aElementIdList) = 0

Generates new numbers for part list.

Parameters:

aElementIdList – [in] [ICwAPI3DElementIDList*] The element list id.

virtual void loadListCalculationSettingsProductionList(const character *aSettingsFilePath) = 0

Loads a settings file for production list calculation.

Parameters:

aSettingsFilePath – [in] [const character*] The settings file path.

virtual void loadListCalculationSettingsPartList(const character *aSettingsFilePath) = 0

Loads a settings file for part list calculation.

Parameters:

aSettingsFilePath – [in] [const character*] The settings file path.

virtual void generateNewNumbersProductionListSilently(ICwAPI3DElementIDList *aElementIdList, uint32_t aStartingNumber, bool aKeepExistingNumbers, bool aWithContainers) = 0

Generates new numbers for production list (silently).

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element list id.

  • aStartingNumber – [in] [uint32_t] The starting number.

  • aKeepExistingNumbers – [in] [bool] True to keep existing numbers, false to overwrite them.

  • aWithContainers – [in] [bool] True to include containers, false to exclude them.

virtual void generateNewNumbersPartListSilently(ICwAPI3DElementIDList *aElementIdList, uint32_t aStartingNumber, bool aKeepExistingNumbers, bool aWithContainers) = 0

Generates new positions numbers for part list.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element list id.

  • aStartingNumber – [in] [uint32_t] The starting number.

  • aKeepExistingNumbers – [in] [bool] True to keep existing numbers, false to overwrite them.

  • aWithContainers – [in] [bool] True to include containers, false to exclude them.

virtual void exportCoverList(ICwAPI3DElementIDList *aElementIdList, const character *aExportFilePath) = 0

Exports a Wall/Roof/Floor list.

Parameters:
virtual void exportCoverListWithSettings(ICwAPI3DElementIDList *aElementIdList, const character *aExportFilePath, const character *aSettingsFilePath) = 0

Exports a Wall/Roof/Floor list with settings file.

Parameters:

  • aElementIdList – [in] [ICwAPI3DElementIDList*] The element list id.

  • aExportFilePath – [in] [const character*] The exported file path.

  • aSettingsFilePath – [in] [const character*] The settings file path.

virtual void exportContainerList(ICwAPI3DElementIDList *aElementIdList, const character *aExportFilePath) = 0

Exports a container list.

Parameters: