CATMecModUseItf Interface CATIMmiUseBRepAccess
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMmiUseBRepAccess
Interface to manage a selecting object.
The selecting objects:
@ref CATIMmiUseRSur, @ref CATIMmiUseBorderREdge, @ref CATIMmiUseWireREdge and @ref CATIMmiUseBorderFVertex
are directely named in the generic naming graph.
The selecting objects:
- See also:
- , , ,
Method Index
- o
CreateBody(CATIMmiMechanicalFeature_var&,CATBody_var&,CATMmrLimitationType)
- Creates the body created with cells associated with the selecting object.
- o
GetBRepAncestors(CATListValCATIMmiUseBRepAccess_var&,CATIMmiMechanicalFeature_var&,CATMfNodeReportType)
- Returns the grandparents of the selecting object.
- o
GetBRepElementType(CATMfBRepAccessElementType&)
- Reads the selecting object type.
- o
GetBRepInitialFeature(CATIMmiMechanicalFeature_var&,CATBoolean)
- Gets the initial feature of the selecting object.
- o
GetBRepLastFeature(CATIMmiMechanicalFeature_var&,CATBoolean)
- Gets the last feature of the selecting object.
- o
GetBRepSelectingCell(CATCell_var&)
- Returns the selected cell.
- o
GetBRepSelectingFeature(CATIMmiMechanicalFeature_var&,CATBoolean)
- Gets the selecting feature of the selecting object.
- o
GetBRepSelectingTopology(CATTopology_var&)
- Returns the selected topology.
- o
IsBRepValid(CATBoolean&)
- Reads the object validity status.
- o
IsSameBRepLabel(CATIMmiUseBRepAccess_var&,CATBoolean&,CATMmrLimitationType)
- Compares two selecting objects.
- o
UnGroup(CATListValCATIMmiUseBRepAccess_var&,CATIMmiMechanicalFeature_var&,CATMfNodeReportType)
- Returns the children selecting objects of the selecting object.
Methods
o CreateBody
| public virtual CreateBody( | const | iFeature, |
| | oBody, |
| | iType | = CATMmrDefaultLimitationType) |
-
Creates the body created with cells associated with the selecting object.
- Parameters:
-
- iFeature
- [in] Search is performed in the body associated with iFeature.
- oBody
- [out] The created body.
- iType
- [in] allows the search to be different than what was selected at the BRep Feature creation.
- iType = CATMmrLimitationTypeDefault
- if CATMmrRelimited or CATMmrFunctional was selected at the creation it gives the same result.
- iType = CATMmrFunctional
- if CATMmrFunctional was selected at the creation it gives the same result,
- if CATMmrRelimited gives the same result as if CATMmrFunctional was selected at the creation.
- Returns:
-
- S_OK
- Successfull.
- E_FAIL
- an error occured.
o GetBRepAncestors
| public virtual GetBRepAncestors( | | oBReps, |
| const | iFeature | = NULL_var, |
| const | iType | = MfModification) |
-
Returns the grandparents of the selecting object.
- Parameters:
-
- oBReps
- [out] The list of CATIMmiUseBRepAccess.
- iFeature
- [in] Search in performed in the iFeature body, in the whole generic naming graph if iFeature is NULL.
- iType
- [in] Legal values:
MfModification,
MfCovering,
MfGeneration specifies the search strategy.
- Returns:
-
- S_OK
- Successfull.
- E_FAIL
- an error occured.
o GetBRepElementType
| public virtual GetBRepElementType( | | oType) |
-
Reads the selecting object type.
- Parameters:
-
- oType
- [out] The type of the selecting object.
Legal values:
MfRSur,
MfREdge,
MfFVertex,
MfBorderREdge,
MfBorderFVertex,
MfWireREdge,
MfWireFVertex,
MfAxis,
MfExtremity,
MfPlanarSubElement,
MfUnknownElementType
- Returns:
-
- S_OK
- successfull.
- E_FAIL
- an error occured.
o GetBRepInitialFeature
| public virtual GetBRepInitialFeature( | | oFeat, |
| | iMaster | = 1) |
-
Gets the initial feature of the selecting object.
Role: this method returns the youngest feature according to the history of the mechanical part, that generated the selecting object.
If this feature is a ResultOUT, it is not displayed in the specification tree.
- Parameters:
-
- oFeat
- [out] The initial feature of the selecting object.
- iMaster
- [in] TRUE : the feature returned is the master feature of the initial feature.
FALSE : the feature returned is the initial feature itself.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o GetBRepLastFeature
| public virtual GetBRepLastFeature( | | oFeat, |
| | iMaster | = 1) |
-
Gets the last feature of the selecting object.
Role: this method returns the feature that generated the selecting object.
This feature is the oldest according to the history of the mechanical part, and takes connexity into account.
If this feature is a ResultOUT, it is not displayed in the specification tree.
- Parameters:
-
- oFeat
- [out] The last feature of the selecting object.
- iMaster
- [in] TRUE : the feature returned is the master feature of the last feature.
FALSE : the feature returned is the last feature itself.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o GetBRepSelectingCell
| public virtual GetBRepSelectingCell( | | oCell) |
-
Returns the selected cell.
- Parameters:
-
- oCell
- [out] The selected cell.
- Returns:
-
- S_OK
- Successfull.
- E_FAIL
- an error occured.
o GetBRepSelectingFeature
| public virtual GetBRepSelectingFeature( | | oFeat, |
| | iMaster | = 1) |
-
Gets the selecting feature of the selecting object.
Role: this method returns the feature containing the selected object.
If this feature is a ResultOUT, it is not displayed in the specification tree.
- Parameters:
-
- oFeat
- [out] The selecting feature of the selecting object.
- iMaster
- [in] TRUE : the feature returned is the master feature of the selecting feature.
FALSE : the feature returned is the selecting feature itself.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o GetBRepSelectingTopology
| public virtual GetBRepSelectingTopology( | | oTopology) |
-
Returns the selected topology.
- Parameters:
-
- oTopology
- [out] The selected topology.
- Returns:
-
- S_OK
- Successfull.
- E_FAIL
- an error occured.
o IsBRepValid
| public virtual IsBRepValid( | | oResult) |
-
Reads the object validity status.
- Parameters:
-
- oResult
- [out] TRUE if the selecting object is valid.
- Returns:
-
- S_OK
- Successfull.
- E_FAIL
- an error occured.
o IsSameBRepLabel
| public virtual IsSameBRepLabel( | const | iBrep, |
| | oResult, |
| | iType | = CATMmrDefaultLimitationType) |
-
Compares two selecting objects.
Role: this method compares two selecting objects.
- Parameters:
-
- iBrep
- [in] Selecting object to be compared.
- oResult
- [out] TRUE if the two selecting objects are same, FALSE else.
- iType
- [in] allows the search to be different than what was selected at the selecting object creation.
- iType = CATMmrLimitationTypeDefault
- if CATMmrRelimited or CATMmrFunctional was selected at the creation it gives the same result.
- iType = CATMmrFunctional
- if CATMmrFunctional was selected at the creation it gives the same result,
- if CATMmrRelimited gives the same result as if CATMmrFunctional was selected at the creation.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o UnGroup
| public virtual UnGroup( | | oList, |
| const | iFeature | = NULL_var, |
| const | iType | = MfModification) |
-
Returns the children selecting objects of the selecting object.
- Parameters:
-
- oList
- [out] The list of CATIMmiUseBRepAccess.
- iFeature
- [in] Search is performed at the iFeature level; in the whole generic naming graph if iFeature is NULL.
- iType
- [in] Legal values:
MfModification,
MfCovering,
MfGeneration specifies the search strategy.
- Returns:
-
- S_OK
- the resolution has been successfull.
- E_FAIL
- an error occured in the resolution.
This object is included in the file: CATIMmiUseBRepAccess.h
If needed, your Imakefile.mk should include the module: CATMecModUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.