All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIMmiBRepScanServices

Usage: you must use this class as is. You should never derive it.

interface CATIMmiBRepScanServices

Class providing services which allow the traversal of a part through selecting objects.
Use CATMmiUseServicesFactory::CreateMmiBRepScanServices to get the services component.

Method Index

o FindDualBRepAccess(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,CATIMmiUseBRepAccess_var&,CATIMmiUseBRepAccess_var&): Retrieves the corresponding selecting object in the copied or reference feature.
o ListAncestorsSinceGenerationFeature(CATIMmiUseBRepAccess_var&,CATListValCATIMmiMechanicalFeature_var&): Retrieves all the ancestors since the generation feature from a selecting object.
o ListFeaturesForGeometry(CATIMmiUseBRepAccess_var&,CATListValCATIMmiMechanicalFeature_var&): Retrieves from a selecting object all the ancestors since the generation feature that modified the geometry.

Methods

o FindDualBRepAccess

public virtual FindDualBRepAccess(	const	`iRefFeature`,
	const	`iCopyFeature`,
		`ioRefBRepAccess`,
		`ioCopyBRepAccess`)

Retrieves the corresponding selecting object in the copied or reference feature.

Role: This method retrieves the corresponding selecting object in the copied/reference feature, when given a selecting object in the reference/copied feature respectively.
It succeeds in finding the dual selecting object only in the Paste As Result With Link and Paste As Result cases. This service does not work in the case of Paste As Spec.

The reference feature should be copied using CATIMmiUseCreateImport.
Subsequently, the method presented here may be called right after the copy-paste operation.
Note:

The results are not guaranteed if an action on the model such as Save has been done before calling the method presented here.

Parameters:

iRefSpecObject

The reference feature.
This is a mechanical feature, which can be a surfacic element (curve, line) or a sketch, or a solid body (PartBody, Body).
Note:

This parameter can be NULL in the case of a Paste As Result with Link, in which case the reference feature is internally retrieved by using iCopySpecObject.
This parameter must not be omitted in the case of Paste As Result.

iCopySpecObject

The copied feature.
This feature results from a copy-paste operation (except Paste As Spec) of the reference feature iRefSpecObject.
Note:

This parameter must not be NULL.

ioRefBRepAccess

The input or output selecting object.

When this parameter is NULL, it is used as the output corresponding to the input in the copied feature: ioCopyBRepAccess.
When this parameter is not NULL, it is used as an input in order to get the corresponding output in the copy: ioCopyBRepAccess.

Note:

When this parameter is NULL, ioCopyBRepAccess must not be NULL.
This parameter must not be NULL when ioCopyBRepAccess is NULL.

ioCopyBRepAccess

The input or output selecting object.

When this parameter is NULL, it is used as the output corresponding to the input in the reference feature: ioRefBRepAccess.
When this parameter is not NULL, it is used as an input in order to get the corresponding output in the reference: ioRefBRepAccess.

Note:

When this parameter is NULL, ioRefBRepAccess must not be NULL.
This parameter must not be NULL when ioRefBRepAccess is NULL.

Returns:

S_OK if the interface CATIMmiUseBRepAccess of the dual selecting object has been found.
E_FAIL if the interface to the dual selecting object has not been found.
E_INVALIDARG if iCopySpecObject is NULL.
E_INVALIDARG if iRefSpecObject is NULL and no reference feature could be retrieved by iCopySpecObject (e.g. in the case of a Paste As Result).
E_INVALIDARG if iRefSpecObject is not NULL and the feature does not match the one referred to by iCopySpecObject.
E_INVALIDARG if ioRefBRepAccess is NULL and ioCopyBRepAccess is NULL too.
E_INVALIDARG if ioRefBRepAccess is not NULL and ioCopyBRepAccess is not NULL either.
E_UNEXPECTED in case an unexpected internal error occurs.

o ListAncestorsSinceGenerationFeature

public virtual ListAncestorsSinceGenerationFeature(	const	`iBRepAccess`,
		`ioAncestorsFeatures`)

Retrieves all the ancestors since the generation feature from a selecting object.

Role: This method retrieves all the ancestors features since the generation feature from a selecting object.

Parameters:

iBRepAccess: The selecting object.
ioAncestorsFeatures: The method appends the list of ancestors features of the selecting object to the input list.
The features are ordered from the most recent feature to the oldest feature.

Returns:

S_OK if the list of ancestors features of the selecting object has been found.
E_FAIL if the list of ancestors features of the selecting object has not been found.
E_INVALIDARG if iBRepAccess is NULL.

o ListFeaturesForGeometry

public virtual ListFeaturesForGeometry(	const	`iBRepAccess`,
		`ioAncestorsFeatures`)

Retrieves from a selecting object all the ancestors since the generation feature that modified the geometry.

Role: This method retrieves from a selecting object all the ancestors features since the generation feature that modified the geometry of the selecting object.

Parameters:

iBRepAccess: The selecting object.
ioAncestorsFeatures: The method appends the list of ancestors features of the selecting object to the input list.
The features are ordered from the most recent feature to the oldest feature.

Returns:

S_OK if the list of ancestors features of the selecting object has been found.
E_FAIL if the list of ancestors features of the selecting object has not been found.
E_INVALIDARG if iBRepAccess is NULL.

This object is included in the file: CATIMmiBRepScanServices.h
If needed, your Imakefile.mk should include the module: CATMecModUseItf