Documentation
    Preparing search index...

    Interface NodeRepresentation

    Common properties for a node

    Additional WorkStepSpecific properties are defined in interfaces extending this interface.

    interface NodeRepresentation {
        comment: string;
        costCenter: string;
        costs: undefined | LegacyCosts;
        importId: undefined | string;
        mass: undefined | number;
        processId: string;
        processRep: ProcessRep;
        sourceMultiplicities: SourceMultiplicity[];
        sourceVertexKeys: string[];
        targetVertexKeys: string[];
        times: undefined | Times;
        userData: StringIndexedInterface;
        userDefinedScalePrices: UserDefinedScalePrice[];
        vertexKey: string;
        workStep: WorkStep;
    }
    Index

    Properties

    comment costCenter costs importId mass processId processRep sourceMultiplicities sourceVertexKeys targetVertexKeys times userData userDefinedScalePrices vertexKey workStep

    Properties

    comment: string

    Comment (empty if there is none)

    costCenter: string

    User-defined cost center

    Value is user-defined. There is no guarantee for this value to be non-empty or valid w.r.t. any external definition.

    costs: undefined | LegacyCosts

    Manufacturing and selling costs for the node (if available)

    importId: undefined | string

    Id submitted with input file

    Note: This id is only present if an input id is explicitly written to UserData.

    mass: undefined | number

    Mass for the node (if available)

    processId: string

    Process identifier of the node

    processRep: ProcessRep

    Process specific data; defines additional properties

    sourceMultiplicities: SourceMultiplicity[]

    Multiplicity for each source node

    Entries correspond to [[sourceVertexKeys]]. For each source node the respective multiplicity is provided.

    For components that occur in more than one (sub-) assembly the source multiplicity can be different from the node's total multiplicity. The source node's multiplicity can be considered the total multiplicity of the component (defined in the associated [[NodeRepresentation]]. The source multiplicity represents the number of instances in a certain assembly (defined here).

    sourceVertexKeys: string[]

    Identifiers of source nodes

    targetVertexKeys: string[]

    Identifiers of target nodes

    times: undefined | Times

    Manufacturing times for the node (if available)

    Note: This property and [[userDefinedScalePrices]] are mutually exclusive.

    Unit time includes the part's multiplicity.

    userData: StringIndexedInterface

    Configurable user-data (e.g. results of custom calculations)

    userDefinedScalePrices: UserDefinedScalePrice[]

    User defined scale prices

    Note: Prices correspond to manufacturing costs including surcharges.

    Note: This property and [[times]] are mutually exclusive.

    vertexKey: string

    Identifier for a node

    A vertexKey is only valid within one instance of [[GraphRepresentation]].

    The structure of vertexKey is an implementation detail. Changes to the structure of vertexKey are not considered a breaking change.

    workStep: WorkStep

    WorkStepType of the node; defines additional properties

    Deprecated; use [[processRep]] instead.

    Settings

    Member Visibility

    On This Page

    Properties