All Frameworks  Class Hierarchy  This Framework  Indexes   

MecModInterfaces Interface CATIMfBRep

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIMfBRep

Interface to manage BRep features.


Method Index


o CreateBody(CATMfBRepBuildType)
Creates the body according to the build type.
o CreateSickBody()
Creates the sick body in case of update error.
o GetBRepBuildType()
Returns the build type.
o GetBRepType()
Returns BRep type.
o GetBRep(CATISpecObject_var&)
Returns the selecting objects associated with the BRep feature.
o GetBody()
Returns the body associated with the BRep feature.
o GetBrepFtrCells(CATMmrLimitationType,CATISpecObject_var&,CATLISTP(CATCell)&)
Retrieves the cells associated with the BRep feature.
o GetBrepFtrGeometryType(CATMmiDimension&,CATMmiDimensionType&)
Retrieves the type of geometry pointed by the BRep Feature.
o GetBrepFtrNecessaryFeatures(CATMmrLimitationType,CATLISTV(CATISpecObject_var)&)
Retrieves all the Features associated with the BRep feature.
o GetCells(CATISpecObject_var&)
Returns the cells associated with the BRep feature.
o GetConnexity(CATISpecObject_var&)
Returns the connectivity of the BRep feature.
o GetEdges(CATISpecObject_var&)
Returns the topological edges CATEdge associated with the BRep feature.
o GetFaces(int)
Returns the topological faces associated with the BRep feature.
o GetFaces(CATISpecObject_var&,int)
Returns the topological faces associated with the BRep feature.
o GetGeometry(CATISpecObject_var&)
Returns the geometrical objects associated with the cells of the BRep feature.
o GetMasterSupport()
Returns the support as a shape feature displayed in the specification tree.
o GetNbSur()
Returns the number of surfaces associated with the BRep feature.
o GetNecessaryFeatures()
Returns the list of features involved in the BRep feature definition.
o GetRSurs(int)
Returns the surface selecting objects associated with the BRep feature.
o GetRSurs(CATISpecObject_var&,int)
Returns the surface selecting objects associated with the BRep feature.
o GetSickBody()
Returns the sick body in case of update error.
o GetSickCells()
Returns the sick cells in case of update error.
o GetSupport()
Returns the support.
o IsABRep(CATMfBRepType)
Returns True if iType is the correct type, otherwise False.
o IsAIntersectionBRep()
Returns True if MfIntersectionBRep is the correct type, otherwise False.
o IsASuperBRep(CATMfSuperBRepType)
Returns True if iType is the correct type, otherwise False.
o IsCompatibleWith(CATIBRepAccess_var&)
Returns True if the selecting object iBRep can generate a this type BRep feature.
o IsImpactedBy(CATISpecObject_var&)
Analyses if the BRep feature involves the input feature.
o IsSame(CATUnicodeString&)
Returns 1 if the labels are same.
o IsSame(CATBaseUnknown_var&)
Returns 1 if the BRep feature is same as iObject.
o IsSolvable(CATISpecObject_var&)
Returns 1 if the BRep feature can be solved.
o Modify(CATIBRepAccess_var&,CATBaseUnknown_var&,CATMfFeaturizeMode)
Changes the definition of the BRep feature with the iNewBrep definition.
o Modify(CATIBRepAccess_var&)
Changes the definition of the BRep feature with the iNewBrep definition.
o UpdateSupport()
Updates the support.
o UpdateSupport(CATMfBRepUpdateSupport)
Updates the support.

Methods


o CreateBody
public virtual CreateBody( const iBuildType)
Creates the body according to the build type.
Parameters:
iBuildType
Legal values: MfWithTemporaryBody, MfWithPermanentBody.
Throws:
CATError
o CreateSickBody
public virtual CreateSickBody()
Creates the sick body in case of update error.
o GetBRepBuildType
public virtual GetBRepBuildType()
Returns the build type.
Returns:
Legal values: MfWithTemporaryBody, MfWithPermanentBody.
Throws:
CATError
o GetBRepType
public virtual GetBRepType()
Returns BRep type.
Returns:
Legal values: MfRelimited, MfFunctional
Throws:
CATError
o GetBRep
public virtual GetBRep( const iFeat=NULL_var)
Returns the selecting objects associated with the BRep feature.
Parameters:
iFeat
Search in performed in the ResultOUT body associated with iFeat.
Throws:
CATError
o GetBody
public virtual GetBody()
Returns the body associated with the BRep feature.
Throws:
CATError
o GetBrepFtrCells
public virtual GetBrepFtrCells( iType,
const iFeat,
oLCells)
Retrieves the cells associated with the BRep feature.
Role: this method gets the lists of cells pointed by the BRep feature.
You can get different cells, depending of the Feature selected for the resolution iFeat, the type of resolution iType and the type define at the creation of the BRep feature.
Parameters:
iType
[in] allows the search to be different than what was selected at the BRep Feature creation.
  • iType = CATMmrRelimited
    if CATMmrRelimited was selected at the creation it gives the same result,
    if CATMmrFunctional return S_FALSE.
  • 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.
oLCells
[out] a list of CATFace or CATEdge or CATVertex.
Returns:
S_OK
the resolution has been successfull.
S_FALSE
the param iType is set to CATMmrRelimited on a BRep feature declare with the value CATMmrFunctional.
E_FAIL
an error occured in the resolution.
Throws:
CATError
o GetBrepFtrGeometryType
public virtual GetBrepFtrGeometryType( oDim,
oType)
Retrieves the type of geometry pointed by the BRep Feature.
Role: this method gets the type of geometry associated with the BRep Feature.
You get the dimension of the geometry oDim and the type of geometry position oType.
Parameters:
oDim
[out] Principal type (dimension : vertex, edge, or face).
oType
[out] Secondary type. Is the element isolated (wire), border, or internal .
Returns:
S_OK or E_FAIL.
Throws:
CATError
o GetBrepFtrNecessaryFeatures
public virtual GetBrepFtrNecessaryFeatures( iType,
oLFeats)
Retrieves all the Features associated with the BRep feature.
Role: this method gets the lists of all the Features used by the BRep feature.
You can get different features, depending on the type of resolution asked iType and the type define at the creation of the BRep feature.
Parameters:
iType
[in] allows the search to be different than what was selected at the BRep Feature creation.
  • iType = CATMmrRelimited
    if CATMmrRelimited was selected at the creation it gives the same result,
    if CATMmrFunctional return S_FALSE.
  • 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] a list of Features used to define the BRep Feature.
Returns:
S_OK
the resolution has been successfull.
S_FALSE
the param iType is set to CATMmrRelimited on a BRep feature declare with the value CATMmrFunctional.
E_FAIL
an error occured in the resolution.
Throws:
CATError
o GetCells
public virtual GetCells( const iFeat=NULL_var)
Returns the cells associated with the BRep feature.
Parameters:
iFeat
Cells are searched on iFeat solid.
Returns:
Either a list of CATFace or CATEdge or CATVertex.
Throws:
CATError
o GetConnexity
public virtual GetConnexity( const iFeat=NULL_var)
Returns the connectivity of the BRep feature.
The BRep feature is not connected when the underlying geometry is made of more than one piece. In such case several nodes have the same label in the generic naming graph. It is connected when the underlying geometry is made of one piece only.
Parameters:
iFeat
Search in performed in the body associated with iFeat.
Returns:
Legal values: MfNoConnex when not connected, MfConnex when connected, MfUnknownConnexity.
Throws:
CATError
o GetEdges
public virtual GetEdges( const iFeat=NULL_var)
Returns the topological edges CATEdge associated with the BRep feature.
Parameters:
iFeat
Defines the body of the search.
Returns:
  • If the BRep feature is a face, returns the boundary edges.
  • If the BRep feature is an edge, returns the topological edges.
  • If the BRep feature is a vertex, returns the topological edges shared by the topological faces adjacent to the vertex.
Throws:
CATError
o GetFaces
public virtual GetFaces( const iNumSur=0)
Returns the topological faces associated with the BRep feature.
Parameters:
iNumSur
Number of faces
Returns:
If the BRep feature is a face, returns the associated topological faces.
If the BRep feature is an edge,
  • iNumSur=0 returns the topological faces on both sides of the edge,
  • iNumSur=1 returns the topological faces on the left side of the edge,
  • iNumSur=2 returns the topological faces on the right side of the edge.

If the selecting object is a vertex,
  • iNumSur=0 returns the topological faces associated with the vertex,
  • iNumSur=i returns the topological faces on the ith side of the vertex.
Throws:
CATError
o GetFaces
public virtual GetFaces( const iFeat,
const iNumSur=0)
Returns the topological faces associated with the BRep feature.
Parameters:
iFeat
Defines the body of the search.
iNumSur
Number of faces
Returns:
If the BRep feature is a face, returns the associated topological faces.
If the BRep feature is an edge,
  • iNumSur=0 returns the topological faces on both sides of the edge,
  • iNumSur=1 returns the topological faces on the left side of the edge,
  • iNumSur=2 returns the topological faces on the right side of the edge.

If the selecting object is a vertex,
  • iNumSur=0 returns the topological faces associated with the vertex,
  • iNumSur=i returns the topological faces on the ith side of the vertex.
Throws:
CATError
o GetGeometry
public virtual GetGeometry( const iFeat=NULL_var)
Returns the geometrical objects associated with the cells of the BRep feature.
Parameters:
iFeat
Geometrical objects are searched on iFeat solid.
Returns:
List of CATGeometry.
Throws:
CATError
o GetMasterSupport
public virtual GetMasterSupport()
Returns the support as a shape feature displayed in the specification tree.
Throws:
CATError
o GetNbSur
public virtual GetNbSur()
Returns the number of surfaces associated with the BRep feature.
Returns:
  • 1 if the BRep feature is a CATIMfFSur or a CATIMfRSur,
  • 2 if the BRep feature is a CATIMfFedge or a CATIMfRedge,
  • 3 and more if the BRep feature is a CATIMfFvertex.
o GetNecessaryFeatures
public virtual GetNecessaryFeatures()
Returns the list of features involved in the BRep feature definition.
Throws:
CATError
o GetRSurs
public virtual GetRSurs( const iNumSur=0)
Returns the surface selecting objects associated with the BRep feature.
Parameters:
iNumSur
Number of surfaces.
Returns:
If the BRep feature is a face, returns the associated selecting objects.
If the BRep feature is an edge,
  • iNumSur=0 returns the selecting objects on both sides of the edge,
  • iNumSur=1 returns the selecting objects on the left side of the edge,
  • iNumSur=2 returns the selecting objects on the right side of the edge.

If the selecting object is a vertex,
  • iNumSur=0 returns the selecting objects associated with the vertex,
  • iNumSur=i returns the selecting objects on the ith side of the vertex.
Throws:
CATError
o GetRSurs
public virtual GetRSurs( const iFeat,
const iNumSur=0)
Returns the surface selecting objects associated with the BRep feature.
Parameters:
iFeat
Defines the body of the search.
iNumSur
Number of surfaces.
Returns:
If the BRep feature is a face, returns the associated selecting objects.
If the BRep feature is an edge,
  • iNumSur=0 returns the selecting objects on both sides of the edge,
  • iNumSur=1 returns the selecting objects on the left side of the edge,
  • iNumSur=2 returns the selecting objects on the right side of the edge.

If the selecting object is a vertex,
  • iNumSur=0 returns the selecting objects associated with the vertex,
  • iNumSur=i returns the selecting objects on the ith side of the vertex.
Throws:
CATError
o GetSickBody
public virtual GetSickBody()
Returns the sick body in case of update error.
o GetSickCells
public virtual GetSickCells()
Returns the sick cells in case of update error.
o GetSupport
public virtual GetSupport()
Returns the support. Support can be a shape feature of the specification tree or a result out of a shape feature.
Throws:
CATError
o IsABRep
public virtual IsABRep( const iType)
Returns True if iType is the correct type, otherwise False.
Parameters:
iType
Legal values: MfRelimited, MfFunctional
Throws:
CATError
o IsAIntersectionBRep
public virtual IsAIntersectionBRep()
Returns True if MfIntersectionBRep is the correct type, otherwise False.
Throws:
CATError
o IsASuperBRep
public virtual IsASuperBRep( const iSuperBRepType=MfSuperBRep)
Returns True if iType is the correct type, otherwise False.
Parameters:
iSuperBRepType
Legal values:
  • MfSimpleBRep,
  • MfSuperBRep,
  • MfSBWithoutSecoursInit,
  • MfSBWithAutomaticSecoursInits,
  • MfSBWithMonoBody,
  • MfSBWithMultiBody,
  • MfSBWithSecondaryInits,
  • MfSBWithoutSecondaryInit,
  • MfIntersectionBRep.
Throws:
CATError
o IsCompatibleWith
public virtual IsCompatibleWith( const iBRep)
Returns True if the selecting object iBRep can generate a this type BRep feature.
Parameters:
iBRep
Selecting object.
Throws:
CATError
o IsImpactedBy
public virtual IsImpactedBy( const iFeat)
Analyses if the BRep feature involves the input feature. If the input feature is deleted, the BRep feature becomes invalid.
Parameters:
iFeat
Design feature.
Throws:
CATError
o IsSame
public virtual IsSame( const iLabel)
Returns 1 if the labels are same.
Parameters:
iLabel
Label.
o IsSame
public virtual IsSame( const iObject)
Returns 1 if the BRep feature is same as iObject.
Parameters:
iObject
Selecting object or BRep feature.
o IsSolvable
public virtual IsSolvable( const iFeat=NULL_var)
Returns 1 if the BRep feature can be solved.
Parameters:
iFeat
Solving is performed on the body of the ResultOUT of iFeat object.
o Modify
public virtual Modify( const iNewBrep,
const iSupport,
const iMode)
Changes the definition of the BRep feature with the iNewBrep definition.
Parameters:
iNewBrep
New BRep definition.
iSupport
New support.
iMode
Legal values:
  • MfNoDuplicateFeature,
  • MfDuplicateFeature,
  • MfTemporaryBody,
  • MfPermanentBody,
  • MfInitialFeatureSupport,
  • MfSelectingFeatureSupport,
  • MfLastFeatureSupport,
  • MfNoFeatureSupport,
  • MfDefaultFeatureSupport,
  • MfWithBuildError,
  • MfWithoutBuildError,
  • MfNoFeaturization,
  • MfFunctionalFeaturization,
  • MfRelimitedFeaturization,
  • MfBorderFeaturization,
  • MfWireFeaturization.
Throws:
CATError
o Modify
public virtual Modify( const iNewBrep)
Changes the definition of the BRep feature with the iNewBrep definition.
Parameters:
iNewBrep
New BRep definition.
Throws:
CATError
o UpdateSupport
public virtual UpdateSupport()
Updates the support.
Throws:
CATError
o UpdateSupport
public virtual UpdateSupport( const iMode)
Updates the support.
Parameters:
iMode
Legal values: MfStandardUpdateSupport, MfForceUpdateSupport.
Returns:
S_OK or E_FAIL.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.