Expand Primitives from 3D Index

You can use the expand from 3D index primitives to expand nodes of an object structure based on 3D index information.

Note: Only leaf node of each occurrence or branch in the Navigation Set is expanded.

Important:
  • To use the I3DexpandEBOM and I3DexpandMBOM primitives, add var ExpandFrom3DIndexPrimitives = Java.type ("com.dassault_systemes.pprcompletion.primitives.DELPPRExpandPrimitive"); in the Header Section of your procedure.
  • To use the I3DRetrieveContext primitive, add var ExpandFrom3DIndexPrimitives = Java.type ("com.dassault_systemes.pprcompletion.primitives.DELPPRContext3DPrimitive"); in the Header Section of your procedure.

This page discusses:

See Also
User-Defined Open and User-Defined Explore Procedures
Expand Primitives
Navigation Primitives
Advanced Primitives
Navigation Set Management Primitives

I3DexpandEBOM

Expands from 3D Index each EBOM occurrence in an input Navigation Set at the specified level with a configuration or/and volume filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration or volume filter
  • EBOMInput: A Navigation Set that contains the EBOM occurrences
  • iDepth: An integer that defines the expansion depth, that is, the number of levels to expand
    Note: If set to 0, all levels are expanded.

Output

  • A Navigation Set that contains the expanded EBOM occurrences

Example

/**
 * Expands a Product navigation set at a specific level
 * 
 * @param ctx       completion context that contains the configuration or/and volume filter
 * @param EBOMInput navigation set that contains the EBOM occurrences to expand
 * @param iDepth    integer that defines the depth of the expand
 *                  Note: If the depth is set to zero, it expands all
 *
 * @return new navigation set that contains the expanded EBOM occurrences
 * @throws Exception
 */
public NavigationSet  I3DexpandEBOM (CompletionContext ctx, NavigationSet EBOMInput, int iDepth) throws Exception;

I3DexpandMBOM

Expands from 3D Index each MBOM occurrence in an input Navigation Set at the 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
  • iDepth: An integer that defines the expansion depth, that is, the number of levels to expand
    Note: If set to 0, all levels are expanded.

Output

  • A Navigation Set that contains the expanded MBOM occurrences

Example

/**
 * Expands a MBOM navigation set at a specific level
 * 
 * @param ctx       completion context that contains the configuration filter
 * @param MBOMInput navigation set that contains the MBOM occurrences to expand
 * @param iDepth    integer that defines the depth of the expand
 *                  Note: If the depth is set to zero, it expands all
 *
 * @return new navigation set that contains the expanded MBOM occurrences
 * @throws Exception
 */
public NavigationSet I3DexpandMBOM (CompletionContext ctx, NavigationSet MBOMInput, int iDepth) throws Exception;

I3DRetrieveContext

Expands from 3D Index all levels, and intersects the EBOM and all the previous MBOM from the selected MBOM input with a configuration or/and volume filter if necessary.

Note: MBOM children from Manufactured Material or Manufactured Part are not retrieved.

Input

  • ctx: A Completion Context that contains the configuration or volume filter
  • EBOMInput: A Navigation Set that contains the EBOM occurrences to expand
  • MBOMInput: A Navigation Set that contains the MBOM occurrences scoped with an EBOM (usually the root MBOM)
  • MBOMInputSelected: A Navigation Set that contains the selected MBOM (usually the install MBOM)

Output

  • A list of Navigation Sets that contains two elements:
    • The expanded EBOM occurrences
    • The expanded MBOM occurrences

Example

/**
 * Expands a MBOM navigation set at a specific level
 * 
 * @param ctx                completion context that contains the configuration or/and volume filter
 * @param EBOMInput          navigation set that contains the EBOM occurrences to expand
 * @param MBOMInput          navigation set that contains the MBOM occurrences scoped with an EBOM (usually the root MBOM)
 * @param MBOMInputSelected  navigation set that contains the selected MBOM occurrences (usually the install MBOM)
 *
 * @return new list of navigation sets that contains 
 *         The expanded EBOM occurrences
 *         The expanded MBOM occurrences
 *
 * @throws Exception
 */
public NavigationSet I3DRetrieveContext (CompletionContext ctx, NavigationSet EBOMInput, NavigationSet MBOMInput, NavigationSet MBOMInputSelected) throws Exception;

How to use output lists of Navigation Set?

var lstNavSet = ExpandFrom3DIndexPrimitives.I3DRetrieveContext (context, PRD, PRCS, SEL_PRCS);
        if (2 == lstNavSet.size ()) {
            var prdNavSetOutput = lstNavSet.get(0);
            var prcsNavSetOutput = lstNavSet.get(1);

            PRD  = PRD.merge (prdNavSetOutput);
            PRCS = PRCS.merge (prcsNavSetOutput);
        }