BillOfMaterial.hpp

Go to the documentation of this file.

//*************************************************************************************
//  BillOfMaterial.hpp
//  Declarations for Bill of Materials traversal functions.
//*************************************************************************************
 
#pragma once
 
#include "datakit.h"
 
// Represents a single entry in the Bill of Materials.
struct BomEntry
{
    Dtk_string partName;             // Prototype (part) name
    Dtk_string instanceName;         // Instance name (empty for the root)
    Dtk_Int32  depth;                // Nesting depth in the assembly tree (root = 0)
    Dtk_Int32  occurrenceCount;      // How many times this part appears at this level
    bool       isMissing;            // true if ComponentMissing flag is set on the prototype
};
 
// Creates a Bill of Materials for the given Dtk_MainDoc by traversing its assembly tree.
void CreateBomForMainDoc( Dtk_MainDocPtr inMainDoc, Dtk_tab<BomEntry> &outBomEntries );
 
// Traverses the assembly tree starting from inComponent and populates outBomEntries.
// inDepth is the current nesting depth (start with 0 for the root).
void TraverseBom(Dtk_ComponentPtr inComponent, Dtk_tab<BomEntry> &outBomEntries, Dtk_Int32 inDepth = 0);
 
// Prints the BOM entries to the standard output in a human-readable tree format.
void PrintBom(const Dtk_tab<BomEntry> &inBomEntries);
 
// Prints a summary that counts how many times each unique part name appears across
// the whole assembly (flattened occurrence count).
void PrintBomSummary(const Dtk_tab<BomEntry> &inBomEntries);