Advanced Primitives

You can use the following primitives for more advanced use, such as defining a proximity filter volume or retrieving the first upper scope of an EBOM.

This page discusses:

ModifyContextWithProximityVolume
getFirstUpperScopeFromMBOMToEBOM

ModifyContextWithProximityVolume

Defines a proximity filter volume inside the context for all the EBOM objects given in input by applying an offset defined in millimeters to these objects. This proximity filter can only be understood by the index-based I3DexpandEBOM expansion primitive.

Important: To use this primitive, add com.dassault_systemes.pprcompletion.primitives.DELPPRFilterPrimitive in the Header Section of your procedure.

Recommendation: Because of the complexity of the algorithm, the size of the product navigation set should not exceed 100. If this size is exceeded, proximity volume computation may fail because of the lack of memory.

Input

ioCompCtx: A Completion Context to modify according to the volume proximity
iNavSetPrd: A Navigation Set that contains the EBOM occurrences
iOffsetInMM: The offset in millimeters
iVolumeMode: eReplace is the only available value for this parameter and it replaces the context volume by the proximity volume.

Output

There is no output parameter.

Example

/**
* Modify the volume context with proximity search (only replace)
* @param ioCompCtx:     completion context to modify with the volume proximity
* @param iNavSetPrd:    navigation set containing the product occurrences
* @param iOffsetInMM:   offset in millimeter
* @param iVolumeMode:   only eReplace for now (replace the context volume by the proximity volume)
* @throws Exception
*/
public static void ModifyContextWithProximityVolume(CompletionContext ioCompCtx, final NavigationSet iNavSetPrd, final double iOffsetInMM, final VolumeMode iVolumeMode) throws Exception

getFirstUpperScopeFromMBOMToEBOM

Navigates from an MBOM occurrence to retrieve the first upper MBOM entity scoped to an EBOM entity, then retrieves the EBOM occurrence.

Important: To use this primitive, add "com.dassault_systemes.pprcompletion.primitives.DELPPRScopePrimitive" in the Header Section of your procedure.

Recommendation: Use this primitive when the EBOM root is not loaded in the session.

Input

iCompCtx: A Completion Context that contains the configuration filter
iNavSetMBOM: A Navigation Set that contains MBOM occurrence
Important: This parameter must contain only one MBOM occurrence.

Output

A list of Navigation Sets that contains:
- A Navigation Set containing one EBOM occurrence
- A Navigation Set containing one MBOM occurrence scoped with the EBOM occurrence
Notes:
- If several scope links exist, then the primitive stops and raises an exception.
- The primitive does not check if the MBOM occurrence given as input in iNavSetMBOM has a scope to the EBOM. Upper scope identification starts on the first MBOM parent of this occurrence.

Example

/**
* Get the first upper scope EBOM and MBOM occurrences from an MBOM occurrence
* @param iCompCtx:    completion context
* @param iNavSetMBOM: navigation set containing the MBOM occurrence
* @return a list of navigation sets:
*                     - Navigation set containing the EBOM occurrence
*                     - Navigation set containing the MBOM occurrence
* @throws Exception
*/
public static List<NavigationSet> getFirstUpperScopeFromMBOMToEBOM(final CompletionContext iCompCtx, final NavigationSet iNavSetMBOM) throws Exception