Documentation
    Preparing search index...

    Interface Article

    One article of the {Document}

    An {Article} models various components of a mechanical engineering assembly.

    interface Article {
        articleId: ArticleId;
        articleName: string;
        articleType: "joining" | "sheetMetalPart" | "tubePart" | "purchasedPart";
        inputFileName: string | null;
        material: Material | null | undefined;
        materialOptions: MaterialOption[] | undefined;
        quantity: Quantity;
        sourceArticles: SourceArticle[];
        terminal: boolean;
    }
    Index

    Properties

    articleId articleName articleType inputFileName material materialOptions quantity sourceArticles terminal

    Properties

    articleId: ArticleId

    ID of this {Article}

    articleName: string

    Name of the article as defined in the CAD file

    articleType: "joining" | "sheetMetalPart" | "tubePart" | "purchasedPart"

    The type of this {Article}

    inputFileName: string | null

    Name of the input CAD file

    material: Material | null | undefined

    The current material

    materialOptions: MaterialOption[] | undefined

    Valid material options

    quantity: Quantity

    Total quantity of this {Article}

    sourceArticles: SourceArticle[]

    List of {Article}s (i.e. sub components) that is required to manufacture this {Article}

    terminal: boolean

    True if this is a terminal {Article}, i.e. directly corresponds to a CAD input file

    Settings

    Member Visibility

    On This Page

    Properties