CATMecModUseItf Interface CATIMmiUseBRep
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMmiUseBRep
Interface used to get information on BRep features or selecting objects.
, CATIMmiUseMfBRep, CATIMmiUseTopoAccess.
Method Index
- o
GetBRepLimitationType(CATMmrLimitationType&)
- Returns Limitation type.
- o
GetBRepSupport(CATIMmiMechanicalFeature_var&,CATBoolean)
- Gets the support feature of the BRep.
- o
GetBrepNecessaryFeatures(CATListValCATIMmiMechanicalFeature_var&,CATMmrLimitationType)
- Retrieves all the Features involved in the definition of the BRep.
- o
GetBreps(CATListValCATIMmiUseBRepAccess_var&,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
- Retrieves the selecting objects associated with the BRep.
- o
GetBreps(CATListValCATIMmiUseBRepAccess_var&,CATMmiDimension,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
- Retrieves the selecting objects associated with the BRep.
- o
IsBRepSolvable(CATIMmiMechanicalFeature_var&,CATBoolean&,CATMmrLimitationType)
- Tests if the the BRep can be solved.
- o
IsImpactedBy(CATIMmiMechanicalFeature_var&,CATBoolean&,CATMmrLimitationType)
- Analyses if the BRep involves a specified feature.
- o
IsSameBRep(CATIMmiUseBRep_var&,CATBoolean&)
- Compares two BReps.
Methods
o GetBRepLimitationType
| public virtual GetBRepLimitationType( | | oLimitationType) |
-
Returns Limitation type.
Role: this method returns the limitation type of the BRep.
- Parameters:
-
- oLimitationType
- [out] The limitation type.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o GetBRepSupport
| public virtual GetBRepSupport( | | oSupport, |
| | iMaster | = TRUE) |
-
Gets the support feature of the BRep.
Role: this method gets the support feature of the BRep.
Support can be a shape feature of the specification tree or a result out of a shape feature.
- Parameters:
-
- oSupport
- [out] The support feature of the BRep.
- iMaster
- [in] TRUE : the feature returned is the master feature of the feature support.
FALSE : the feature returned is the feature support itself.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
o GetBrepNecessaryFeatures
| public virtual GetBrepNecessaryFeatures( | | oLFeats, |
| | iType | = CATMmrDefaultLimitationType ) |
-
Retrieves all the Features involved in the definition of the BRep.
Role: this method gets the lists of all the Features involved in the definition of the BRep.
You can get different features, depending on the type of resolution asked iType and the type define at the creation of the BRep.
- Parameters:
-
- iType
- [in] allows the search to be different than what was selected at the BRep creation.
- iType = CATMmrDefaultLimitationType
- 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.
- oLFeats
- [out] The list of Features involved in the definition of the BRep.
- Returns:
-
- S_OK
- the resolution has been successfull.
- E_FAIL
- an error occured in the resolution.
o GetBreps
| public virtual GetBreps( | | oList, |
| | iType | = CATMmrDefaultLimitationType, |
| const | iFeat | = NULL_var ) |
-
Retrieves the selecting objects associated with the BRep.
Role: this method gets the lists of selecting objects associated with the BRep.
You can get different selecting objects, depending of the Feature selected for the resolution iFeat, the type of resolution iType and the type defined at the creation of the BRep.
- Parameters:
-
- oList
- [out] The list of CATIMmiUseBRepAccess.
- iType
- [in] allows the search to be different than what was selected at the BRep creation.
- iType = CATMmrDefaultLimitationType
- 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.
- iFeat
- [in] Search is performed in the ResultOUT body associated with iFeat solid.
- Returns:
-
- S_OK
- the resolution has been successfull.
- E_FAIL
- an error occured in the resolution.
o GetBreps
| public virtual GetBreps( | | oList, |
| | iDim, |
| | iType | = CATMmrDefaultLimitationType, |
| const | iFeat | = NULL_var ) |
-
Retrieves the selecting objects associated with the BRep.
Role: this method gets the lists of selecting objects associated with the BRep.
You can get different selecting objects, depending of the Feature selected for the resolution iFeat, the type of resolution iType and the type defined at the creation of the BRep.
- Parameters:
-
- oList
- [out] a list of CATIMmiUseBRepAccess.
- iDim
- [in] The selecting objects in oList will be of dimension iDim.
- iType
- [in] allows the search to be different than what was selected at the BRep creation.
- iType = CATMmrDefaultLimitationType
- 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.
- iFeat
- [in] Search is performed in the ResultOUT body associated with iFeat solid.
- Returns:
-
- S_OK
- the resolution has been successfull.
- E_FAIL
- an error occured in the resolution.
o IsBRepSolvable
| public virtual IsBRepSolvable( | const | iFeature, |
| | oResult, |
| | iType | = CATMmrDefaultLimitationType) |
-
Tests if the the BRep can be solved.
Role: this method tests if the the BRep can be solved on the body of the ResultOUT of iFeature object.
- Parameters:
-
- iFeature
- [in] Solving is performed in the body of the ResultOUT of iFeature object.
- oResult
- [out] TRUE if the BRep can be solved on the body of the ResultOUT of iFeature object.
- iType
- [in] allows the search to be different than what was selected at the BRep creation.
- iType = CATMmrDefaultLimitationType
- 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
- the resolution has been successfull.
- E_FAIL
- an error occured in the resolution.
o IsImpactedBy
| public virtual IsImpactedBy( | const | iFeat, |
| | oResult, |
| | iType | = CATMmrDefaultLimitationType) |
-
Analyses if the BRep involves a specified feature.
Role: this method analyses if the selecting object involves a specified feature.
If the specified feature is deleted, the selecting object becomes invalid.
- Parameters:
-
- iFeat
- [in] Design feature.
- oResult
- [out] TRUE if the specified feature is involved in the definition of the BRep.
- iType
- [in] allows the search to be different than what was selected at the BRep creation.
- iType = CATMmrDefaultLimitationType
- 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
- the resolution has been successfull.
- E_FAIL
- an error occured in the resolution.
o IsSameBRep
| public virtual IsSameBRep( | const | iBrep, |
| | oResult) |
-
Compares two BReps.
Role: this method compares two BReps.
- Parameters:
-
- iBrep
- [in] Brep to be compared.
- oResult
- [out] TRUE if the two BReps are same, FALSE else.
- Returns:
-
- S_OK
- Successful.
- E_FAIL
- an error occured.
This object is included in the file: CATIMmiUseBRep.h
If needed, your Imakefile.mk should include the module: CATMecModUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.