(HOOPS Publish Advanced) Module to calculate a BOM on a modelfile. More...

Data Structures

struct  A3DPDF3DNodesReferencesData
 Structure that defines a set of 3D nodes. Usually used to be referred in a slide table row. Each element can contain several instances. We can get the uuids for each instance. More...
 
struct  A3DPDFBomElementInfoData
 Structure that defines an element in a BOM. More...
 

Functions

A3DStatus A3DPDFFreeBOMInfo (A3DInt32 iNbElements, A3DPDFBomElementInfoData **ppBomElementInfo, A3DPDF3DNodesReferencesData **pp3DNodesReferences)
 Function to free the memory allocated for the information of the BOM. More...
 
A3DStatus A3DPDFGetBOMInfo (A3DAsmModelFile *pModelFile, A3DRWParamsPrcWriteHelper *pPrcWriteHelper, A3DBool bHierarchical, A3DInt32 *piNbElements, A3DPDFBomElementInfoData **ppBomElementInfo, A3DPDF3DNodesReferencesData **pp3DNodesReferences)
 Function to automatically compute a bill of material (BOM) from a modelfile. More...
 

Detailed Description

(HOOPS Publish Advanced) Module to calculate a BOM on a modelfile.

This module describes the functions and structures that allow you to calculate a Bill Of Material on a modelfile.

Function Documentation

◆ A3DPDFGetBOMInfo()

A3DStatus A3DPDFGetBOMInfo ( A3DAsmModelFile pModelFile,
A3DRWParamsPrcWriteHelper pPrcWriteHelper,
A3DBool  bHierarchical,
A3DInt32 piNbElements,
A3DPDFBomElementInfoData **  ppBomElementInfo,
A3DPDF3DNodesReferencesData **  pp3DNodesReferences 
)

Function to automatically compute a bill of material (BOM) from a modelfile.

The function returns an array of elements in the BOM. Each element is the set of components in the assembly associated with the part.

Parameters
[in]pModelFileThe model file to work with.
[in]pPrcWriteHelperUsed to get PRC data such as unique identifiers for PRC nodes.
[in]bHierarchicalTrue if the BOM is hierarchical, false if it is flattened.
[out]piNbElementsThe number of elements in the BOM. In a bom table, it would be the number of lines.
[out]ppBomElementInfoArray of details of the elements in the BOM.
[out]pp3DNodesReferencesArray of details of the node references for elements in the BOM.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
8.1

◆ A3DPDFFreeBOMInfo()

A3DStatus A3DPDFFreeBOMInfo ( A3DInt32  iNbElements,
A3DPDFBomElementInfoData **  ppBomElementInfo,
A3DPDF3DNodesReferencesData **  pp3DNodesReferences 
)

Function to free the memory allocated for the information of the BOM.

Parameters
[in]iNbElementsThe number of elements to free.
[in,out]ppBomElementInfoArray of details of the elements in the BOM.
[in,out]pp3DNodesReferencesArray of details of the node references for elements in the BOM.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
8.1