Navigation Primitives

You can use navigation primitives to retrieve objects through links.

Note: Navigation is made through links according to the defined navMode, from all nodes of each occurrence or branch of the Navigation Set (except for the getAllProcessPredecessors primitive).

Important: To use the following primitives, add var NavigationPrimitives = Java.type ("com.dassault_systemes.completion.service.NavigationPrimitives"); in the Header Section of your procedure.

This page discusses:

See Also
User-Defined Open and User-Defined Explore Procedures
Expand Primitives
Expand Primitives from 3D Index
Advanced Primitives
Navigation Set Management Primitives

navigateFromMBOMToEBOM

Navigates from a set of MBOM occurrences to a set of product occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • MBOMInput: A Navigation Set that contains the MBOM occurrences
  • navMode: A Boolean array that specifies the three navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iRef_OccRef: If true, navigates on a reference-occurrence-reference pattern
    • iInst_Occ: If true, navigates on an instance-occurence pattern

Output

  • A Navigation Set that contains the product occurrences

Example

/**
 * Navigates from a MBOM navigation set to a Product one via implement links
 *
 * @param ctx:       completion context
 * @param MBOMInput: MBOM navigation set
 *                   Note: Implement link connections are added to the MBOM navigation set
 * @param navMode:   navigation mode
 *        Array of 3 Boolean    
 *           First row:  iRef_Ref 
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iRef_OccRef
 *                       true to retrieve the Ref/Occ/Ref pattern
 *           Third row:  iInst_Occ
 *                       true to retrieve the Inst/Occ pattern
 *
 * @return Product navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromMBOMToEBOM (CompletionContext ctx, NavigationSet MBOMInput, boolean[] navMode) throws Exception;

navigateFromEBOMToMBOM

Navigates from a set of product occurrences to a set of MBOM occurrences through implement links, with a configuration filter if necessary.

Note: If there is a partial scope linked to the EBOM, then it is ignored.

Input

  • ctx: A Completion Context that contains the configuration filter
  • prdInput: A Navigation Set that contains the product occurrences
  • navMode: A Boolean array that specifies the three navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iRef_OccRef: If true, navigates on a reference-occurrence-reference pattern
    • iInst_Occ: If true, navigates on an instance-occurence pattern

Output

  • A Navigation Set that contains the MBOM occurrences

Example

/**
 * Navigates from a Product navigation set to a MBOM one via implement links
 *
 * @param ctx:      completion context
 * @param prdInput: Product navigation set
 * @param navMode:  navigation mode
 *        Array of 3 boolean    
 *           First row:  iRef_Ref 
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iRef_OccRef
 *                       true to retrieve the Ref/Occ/Ref pattern
 *           Third row:  iInst_Occ
 *                       true to retrieve the Inst/Occ pattern
 *
 * @return MBOM navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromEBOMToMBOM (CompletionContext ctx, NavigationSet prdInput, boolean[] navMode) throws Exception;

fastenersAnalysisBothSides

Retrieves fasteners occurrences and fastened parts occurrences associated with a product occurrence set through fastener stacking navigation, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • prdInput: A Navigation Set that contains the product occurrences

Output

  • A Navigation Set that contains the fasteners occurrences and the fastened parts occurrences

Example

/**
 * Retrieves Fasteners occurrences and Fastened Parts occurrences associated to a Product navigation set through Fastener stacking navigation
 *
 * @param ctx:       completion context
 * @param prdInput:  product navigation set
 *
 * @return navigation set that contains the Fasteners connections, the corresponding Fasteners occurrences and the fastened Parts occurrences 
 * @throws Exception
 */
public static NavigationSet fastenersAnalysisBothSides (CompletionContext ctx, NavigationSet prdInput) throws Exception;

getEBOMThroughMBOMAssignmentFilter

Retrieves the products linked to a set of MBOM occurrences through Assignment Filters links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • MBOMInput: A Navigation Set that contains the MBOM occurrences
  • withCandidateProductforRerouting: A Boolean that defines the navigation mode:
    • If true, navigates through Physical IDs
    • If false, navigates through Logical IDs

Output

  • A Navigation Set that contains the Product linked the MBOM occurrences

Example

/**
 * Retrieves Product pointed by the MBOM Item thanks to Assignment Filter link
 *
 * @param ctx:                             completion context
 * @param MBOMInput:                       navigation set that contains the MBOM objects 
 * @param withCandidateProductforRerouting 
 *                                         false: navigation based on physical ID matching / 
 *                                         true:  navigation based on logicalID matching
 *
 * @return A navigation set that contains the Products linked 
 * @throws Exception
 */
public static NavigationSet getEBOMThroughMBOMAssignmentFilter (CompletionContext ctx, NavigationSet  MBOMInput, boolean withCandidateProductforRerouting) throws Exception

getMBOMPredecessors

Retrieves the predecessors of a set of MBOM occurrences at a specified level, with a configuration filter if necessary

Input

  • ctx: A Completion Context that contains the configuration filter
  • MBOMInput: A Navigation Set that contains the MBOM occurrences
  • levelOfPredecessors: An integer that defines the number of levels of predecessors to retrieve
    Note: If set to 0, all levels are retrieved.

Output

  • A Navigation Set that contains the predecessors of the MBOM occurrences

Example

/**
 * Retrieves MBOM predecessors at a specific level
 *
 * @param ctx:                 completion context
 * @param MBOMInput:           navigation set that contains the MBOM for which we want to retrieve their predecessors
 * @param levelOfPredecessors: the level of predecessor that we want to retrieve
 *                             Note: If its value is zero, it will retrieve all predecessor
 *
 * @return A navigation set that contains the MBOM and predecessors
 * @throws Exception
 */
public static NavigationSet getMBOMPredecessors (CompletionContext ctx, NavigationSet  MBOMInput, int levelOfPredecessors) throws Exception;

getResultingProductFromMBOM

Navigates from a set of MBOM occurrences to a set of Resulting Product references through data materialization links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • MBOMInput: A Navigation Set that contains the MBOM occurrences
    Note: Only the MBOM references are used.

Output

  • A Navigation Set that contains the product occurrences (containing references only)

Example

/**
 * Retrieves list of Resulting Product References associated to a MBOM navigation set thanks to Data Materialization link 
 *
 * @param ctx:       completion context
 * @param MBOMInput: MBOM navigation set
 *
 * @return A navigation set that contains the Resulting Product references 
 * @throws Exception
 */
public NavigationSet getResultingProductFromMBOM (CompletionContext ctx, NavigationSet MBOMInput) throws Exception;

navigateFromWorkPlanToMBOM

Navigates from a set of workplan occurrences to a set of MBOM occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • wkplInput: A Navigation Set that contains the workplan occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iOcc_Occ: If true, navigates on an occurrence-occurence pattern

Output

  • A Navigation Set that contains the MBOM occurrences

Example

/**
 * Navigates from a Work Plan navigation set to a MBOM one via implement links
 *
 * @param ctx:       completion context
 * @param wkplInput: Work plan navigation set
 * @param navMode:   navigation mode
 *        Array of 2 boolean    
 *           First row:  iRef_Ref
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iOcc_Occ
 *                       true to retrieve the Occ/Occ
 *
 * @return MBOM navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromWorkPlanToMBOM (CompletionContext ctx, NavigationSet wkplInput, boolean[] navMode) throws Exception;

navigateFromMBOMToWorkPlan

Navigates from a set of MBOM occurrences to a set of workplan occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • MBOMInput: A Navigation Set that contains the MBOM occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iOcc_Occ: If true, navigates on an occurrence-occurence pattern

Output

  • A Navigation Set that contains the workplan occurrences

Example

/**
 * Navigates from a MBOM navigation set to a Work Plan one via implement links
 *
 * @param ctx:       completion context
 * @param MBOMInput: MBOM navigation set
 * @param navMode:   navigation mode
 *        Array of 2 boolean    
 *           First row:  iRef_Ref
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iOcc_Occ
 *                       true to retrieve the Occ/Occ
 *
 * @return Work Plan navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromMBOMToWorkPlan (CompletionContext ctx, NavigationSet MBOMInput, boolean[] navMode) throws Exception;

navigateFromProcessToMBOM

Navigates from a set of system or workplan occurrences to a set of MBOM occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • systInput: A Navigation Set that contains the system occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iOcc_Occ: If true, navigates on an occurrence-occurence pattern

Output

  • A Navigation Set that contains the MBOM occurrences

Example

/**
 * Navigates from a System navigation set to a MBOM one via implement links
 *
 * @param ctx:       completion context
 * @param systInput: System navigation set
 * @param navMode:   navigation mode
 *        Array of 2 boolean
 *           First row:  iRef_Ref
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iOcc_Occ
 *                       true to retrieve the Occ/Occ
 *
 * @return MBOM navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromProcessToMBOM (CompletionContext ctx, NavigationSet systInput, boolean[] navMode) throws Exception;

navigateFromMBOMToSystem

Navigates from a set of MBOM occurrences to a set of system occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • MBOMInput: A Navigation Set that contains the MBOM occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iOcc_Occ: If true, navigates on an occurrence-occurence pattern

Output

  • A Navigation Set that contains the system occurrences

Example

/**
 * Navigates from a MBOM navigation set to a Production System one via implement links
 *
 * @param ctx:       completion context
 * @param MBOMInput: MBOM navigation set
 * @param navMode:   navigation mode
 *        Array of 2 boolean
 *           First row:  iRef_Ref
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iOcc_Occ
 *                       true to retrieve the Occ/Occ   
 *
 * @return Production Systems navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromMBOMToSystem (CompletionContext ctx, NavigationSet MBOMInput, boolean[] navMode) throws Exception;

navigateFromSystemToWorkPlan

Navigates from a set of system occurrences to a set of workplan occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • systInput: A Navigation Set that contains the system occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iOcc_Occ: If true, navigates on an occurrence-occurence pattern

Output

  • A Navigation Set that contains the workplan occurrences

Example

/**
 * Navigates from a Production System navigation set to a Work Plan one via implement links
 *
 * @param ctx:       completion context
 * @param systInput: Production System navigation set
 * @param navMode:   navigation set
 *        Array of 2 boolean    
 *           First row:  iRef_Ref
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iOcc_Occ
 *                       true to retrieve the Occ/Occ
 *
 * @return Work plan navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromSystemToWorkPlan (CompletionContext ctx, NavigationSet systInput, boolean[] navMode) throws Exception;

navigateFromWorkPlanToSystem

Navigates from a set of workplan occurrences to a set of system occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • wkplInput: A Navigation Set that contains the workplan occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern
    • iOcc_Occ: If true, navigates on an occurrence-occurence pattern

Output

  • A Navigation Set that contains the system occurrences

Example

/**
 * Navigates from a Work Plan navigation set to a Production System one via implement links
 *
 * @param ctx:       completion context
 * @param wkplInput: Work Plan navigation set
 * @param navMode:   navigation mode
 *        Array of 2 boolean
 *           First row:  iRef_Ref
 *                       true to retrieve the Ref/Ref pattern
 *           Second row: iOcc_Occ
 *                       true to retrieve the Occ/Occ
 * @return Production System navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromWorkPlanToSystem (CompletionContext ctx, NavigationSet wkplInput, boolean[] navMode) throws Exception;

getAllProcessPredecessors

Retrieves all predecessors of a set of system, workplan, or operation occurrences, with a configuration filter if necessary.

Note: Navigation is made through links according to the defined navMode, from only leaf node of each occurrence or branch in the Navigation Set.

Input

  • ctx: A Completion Context that contains the configuration filter
  • systInput: A Navigation Set that contains the system, workplan, or operation occurrences

Output

  • A Navigation Set that contains the Predecessors of the system, workplan, or operation occurrences

Example

/**
 * Retrieves all predecessors for a given Production System, Work Plan or Operation.
 *
 * @param ctx:       completion context
 * @param systInput: navigation set that contains the Production System, Work Plan or Operation that we want to retrieve their predecessors
 *
 * @return new navigation set that contains the predecessors of Input
 * @throws Exception
 */
public NavigationSet  getAllProcessPredecessors (CompletionContext ctx, NavigationSet systInput) throws Exception;

getCapableRscLinkInContextFromProcess

Navigates from a set of process occurrences to a set of capable resources in context, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • processInput: A Navigation Set that contains the process occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iContext: If true, navigates the scope link to retrieve the capable resource in context.
    • iLink: If true, navigates the link to retrieve the capable resource in context.

Output

  • A Navigation Set that contains the capable resources in context occurrences
    Important: This navigation set can only be merged with a resource navigation set.

Example

/**
 * Retrieve list of Capable Resource references in context associated to a System or Workplan navigation set
 * Input parameters:
 * @param ctx:           completion context
 * @param processInput:  System or Workplan navigation set
 * @param navMode:       navigation mode
 *        Array of 2 Boolean    
 *           First row:  iContext
 *                       true to retrieve the Capable Resource link in context scope
 *           Second row: iLink
 *                       true to retrieve the Capable Resource link in context
 *
 * @return A navigation set that contains the Capable Resources in context occurrences
 * Caution: This navigation set can only be merged with a resource navigation set
 * @throws Exception
 */
public static NavigationSet getCapableRscLinkInContextFromProcess (CompletionContext compCtx, NavigationSet processInput, boolean[] navMode) throws Exception

getAssetRscLinkFromWorkplan

Navigates from a set of process to a set of resource asset reference occurrences, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • processInput: A Navigation Set that contains the process occurrences
  • navMode: A Boolean array that specifies the two navigation modes:
    • iContext: If true, navigates the context link to retrieve the asset structure.
    • iLink: If true, navigates the link to retrieve the preassigned work center.

Output

  • A Navigation Set that contains the resource asset reference occurrences
    Important: This navigation set can only be merged with a resource navigation set.

Example

/**
 * Retrieve list of resource asset references associated to a System or Workplan navigation set
 * Input Parameters:
 * @param ctx:          completion context
 * @param processInput: System or Workplan navigation set
 * @param navMode:      navigation mode
 *        Array of 2 Boolean    
 *           First row:  iContext
 *                       true to retrieve the Assets Structure link
 *           Second row: iLink
 *                       true to retrieve the Pre-assigned Workcenter link
 *
 * @return A navigation set that contains the resource asset references occurrences
 * Caution: This navigation set can only be merged with a resource navigation set
 * @throws Exception
 */
public static NavigationSet getAssetRscLinkFromWorkplan(CompletionContext compCtx, NavigationSet processInput, boolean[] navMode) throws Exception

getCapableRscLinkFromProcess

Navigates from a set of process occurrences to a set of capable resource references, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • processInput: A Navigation Set that contains the process occurrences
  • navMode: A Boolean array that specifies the three navigation modes:
    • iContext: If true, navigates the scope link to retrieve the capable resource structure.
    • iPrimLink: If true, navigates the link to retrieve the primary capable resource.
    • iSecLink: If true, navigates the link to retrieve the secondary capable resource.

Output

  • A Navigation Set that contains the capable resource occurrences (containing references only)
    Important: This navigation set can only be merged with a capable resource navigation set.

Example

/**
 * Retrieve list of Capable Resources References associated to a System or Workplan navigation set
 * Input parameters:
 * @param ctx:          completion context
 * @param processInput: System or Workplan navigation set
 * @param navMode:      navigation mode
 *        Array of 3 Boolean    
 *           First row:  iContext
 *                       true to retrieve the Capable Resources Structure link
 *           Second row: iPrimLink
 *                       true to retrieve the Primary Capable Resource link
 *           Third row:  iSecLink
 *                       true to retrieve the Secondary Capable Resource link
 *
 * @return A navigation set that contains the Capable Resources occurrences
 * Caution: This navigation set can only be merged with a capable resource navigation set
 * @throws Exception
 */
public static NavigationSet getCapableRscLinkFromProcess(CompletionContext compCtx, NavigationSet processInput, boolean[] navMode) throws Exception

navigateFromProcessToResource

Navigates from a set of process occurrences to a set of resource occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • processes: A Navigation Set that contains the process occurrences
  • navMode: A Boolean array that specifies the four navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern for the scope
    • iOcc_Occ_With: If true, navigates on an occurrence-occurence pattern for the "with" resources only
    • iOcc_Occ_Where: If true, navigates on an occurrence-occurence pattern for the "where" resources only
    • iOcc_Occ_Who: If true, navigates on an occurrence-port-occurence pattern for the "who" resources only

Output

  • A Navigation Set that contains the resource occurrences (containing instances and references)

Example

/**
 * Navigates from a system or workplan navigation set to a resource one via implement links
 * Input parameters:
 * @param ctx:       completion context
 * @param processes: process navigation set
 * @param navMode:
 *        Array of 4 boolean    
 *           First row : iRef_Ref
 *                       true to retrieve the Ref/Ref pattern for the scope link
 *           Second row: iOcc_Occ_With
 *     	            true to retrieve the Occ/Occ for the “with” Resource link only
 *           Third row : iOcc_Occ_Where
 *                       true to retrieve the Occ/Occ for the “where” Resource link only
 *           Fourth row: iOcc_Occ_Who
 *                       true to retrieve the Occ/Port/Occ for the “who” Resource link only
 *
 * @return resource navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromProcessToResource(CompletionContext compCtx, NavigationSet processes, boolean[] navMode) throws Exception

navigateFromResourceToSystem

Navigates from a set of resources to a set of system occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • resources: A Navigation Set that contains the resource occurrences
  • navMode: A Boolean array that specifies the four navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern for the scope
    • iOcc_Occ_With: If true, navigates on an occurrence-occurence pattern for the "with" resources only
    • iOcc_Occ_Where: If true, navigates on an occurrence-occurence pattern for the "where" resources only
    • iOcc_Occ_Who: If true, navigates on an occurrence-port-occurence pattern for the "who" resources only

Output

  • A Navigation Set that contains the system occurrences

Example

/**
 * Navigates from a resource via implement links to a production system navigation set
 * Input parameters:
 * @param ctx:       completion context
 * @param resources: resource navigation set
 * @param navMode:
 *        Array of 4 boolean    
 *           First row : iRef_Ref 
 *                       true to retrieve the Ref/Ref pattern for the scope link
 *           Second row: iOcc_Occ_With
 *                        true to retrieve the Occ/Occ for the “with” Resource link only
 *           Third row : iOcc_Occ_Where
 *     	            true to retrieve the Occ/Occ for the “where” Resource link only
 *           Fourth row: iOcc_Occ_Who
 *                       true to retrieve the Occ/Port/Occ for the “who” Resource link only
 *
 * @return system navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromResourceToSystem(CompletionContext compCtx, NavigationSet resources, boolean[] navMode) throws Exception

navigateFromResourceToWorkplan

Navigates from a set of resources to a set of workplan occurrences through implement links, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • resources: A Navigation Set that contains the resource occurrences
  • navMode: A Boolean array that specifies the four navigation modes:
    • iRef_Ref: If true, navigates on a reference-reference pattern for the scope
    • iOcc_Occ_With: If true, navigates on an occurrence-occurence pattern for the "with" resources only
    • iOcc_Occ_Where: If true, navigates on an occurrence-occurence pattern for the "where" resources only
    • iOcc_Occ_Who: If true, navigates on an occurrence-port-occurence pattern for the "who" resources only

Output

  • A Navigation Set that contains the workplan occurrences

Example

/**
 * Navigates from a resource via implement links to a WorkPlan navigation set
 * Input parameters:
 * @param ctx:       completion context
 * @param resources: resource navigation set
 * @param navMode:
 *        Array of 4 boolean    
 *           First row : iRef_Ref 
 *                       true to retrieve the Ref/Ref pattern for the scope link
 *           Second row: iOcc_Occ_With
 *                       true to retrieve the Occ/Occ for the “with” Resource link only
 *           Third row : iOcc_Occ_Where
 *                       true to retrieve the Occ/Occ for the “where” Resource link only
 *           Fourth row: iOcc_Occ_Who
 *                       true to retrieve the Occ/Port/Occ for the “who” Resource link only
 *
 * @return workplan navigation set
 * @throws Exception
 */
public static NavigationSet navigateFromResourceToWorkPlan(CompletionContext compCtx, NavigationSet resources, boolean[] navMode) throws Exception