CATMecModUseItf Interface CATIMmiUseTopoAccess

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

interface CATIMmiUseTopoAccess

Interface to retrieve topological information on BRep objects.
, CATIMmiUseMfBRep, CATIMmiUseBRep.

Method Index


o GetBodySupport(CATBody_var&)
Gets the body containing the cells.
o GetBrepCells(CATListPtrCATCell&,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the cells associated with the BRep.
o GetBrepCells(CATListPtrCATCell&,CATMmiDimension,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the cells associated with the BRep.
o GetBrepFaces(CATListPtrCATFace&,CATListOfInt&,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the faces associated with the BRep.
o GetBrepFtrGeometryType(CATMmiDimension&,CATMmiDimensionType&)
Retrieves the type of geometry pointed.
o GetBrepGeometries(CATListPtrCATGeometry&,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the geometries associated with the BRep.
o GetBrepGeometries(CATListPtrCATGeometry&,CATMmiDimension,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the geometries associated with the BRep.
o GetBrepTopologies(CATListPtrCATTopology&,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the topologies associated with the BRep.
o GetBrepTopologies(CATListPtrCATTopology&,CATMmiDimension,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the topologies associated with the BRep.
o GetConnexity(CATMfConnexityType&,CATMmrLimitationType,CATIMmiMechanicalFeature_var&)
Retrieves the connectedness of the BRep.

Methods


o GetBodySupport
public virtual GetBodySupport( oBody)
Gets the body containing the cells.
Role: this method gets the body containing the cells.
Parameters:
oBody
[out] The CATBody.
Returns:
S_OK
Successfull.
E_FAIL
an error occured.
o GetBrepCells
public virtual GetBrepCells( oList,
iType= CATMmrDefaultLimitationType,
const iFeat= NULL_var )
Retrieves the cells associated with the BRep.
Role: this method gets the lists of cells associated with the BRep.
You can get different cells, 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 CATFace, CATEdge or CATVertex.
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 GetBrepCells
public virtual GetBrepCells( oList,
iDim,
iType= CATMmrDefaultLimitationType,
const iFeat= NULL_var )
Retrieves the cells associated with the BRep.
Role: this method gets the lists of cells associated with the BRep.
You can get different cells, 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 CATFace, CATEdge or CATVertex.
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 GetBrepFaces
public virtual GetBrepFaces( oList,
oCardList,
iType= CATMmrDefaultLimitationType,
const iFeat= NULL_var )
Retrieves the faces associated with the BRep.
Role: this method gets the lists of faces associated with the BRep.
Parameters:
oList
[out] a list of CATFace.
oCardList
[out] See GetBrepFtrGeometryType. If the dimension of the BRep is a CATMmiFace then oCardList[1] is the number of faces.
If the dimension of the BRep is a CATMmiEdge and the dimension type is CATMmiInternal then oCardList[1] is the number of adjacent left faces and oCardList[2] is the number of adjacent right faces.
If the dimension of the BRep is a CATMmiVertex and the dimension type is CATMmiInternal then oCardList[i] is the number of faces adjacent to the vertex, faces that are trimmed pieces of the same initial face.
If the dimension of the BRep is a CATMmiEdge and the dimension type is CATMmiBorder then oCardList[1] is the number of faces adjacent to the edge. All these faces are located on the same side of the edge in case of the selecting object is a border edge.
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 GetBrepFtrGeometryType
public virtual GetBrepFtrGeometryType( oDim,
oType)
Retrieves the type of geometry pointed.
Role: this method gets the type of geometry associated with the BRep.
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.
o GetBrepGeometries
public virtual GetBrepGeometries( oList,
iType= CATMmrDefaultLimitationType,
const iFeat= NULL_var )
Retrieves the geometries associated with the BRep.
Role: this method gets the lists of geometries associated with the BRep.
You can get different geometries, 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 CATGeometry.
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 GetBrepGeometries
public virtual GetBrepGeometries( oList,
iDim,
iType= CATMmrDefaultLimitationType,
const iFeat= NULL_var )
Retrieves the geometries associated with the BRep.
Role: this method gets the lists of geometries associated with the BRep.
You can get different geometries, depending of the Feature selected for the resolution iFeat, the type of resolution iType and the type defined at the creation of the BRep feature.
Parameters:
oList
[out] a list of CATGeometry.
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 GetBrepTopologies
public virtual GetBrepTopologies( oList,
iType= CATMmrDefaultLimitationType,
const iFeat= NULL_var )
Retrieves the topologies associated with the BRep.
Role: this method gets the lists of topologies associated with the BRep.
You can get different topologies, 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 CATDomain, CATVolume, CATFace, CATEdge or CATVertex.
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 GetBrepTopologies
public virtual GetBrepTopologies( oList,
iDim,
iType= CATMmrDefaultLimitationType,
const iFeat= NULL_var )
Retrieves the topologies associated with the BRep.
Role: this method gets the lists of topologies associated with the BRep.
You can get different topologies, 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 CATDomain, CATVolume, CATFace, CATEdge or CATVertex.
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 GetConnexity
public virtual GetConnexity( oConnectedness,
iType= CATMmrDefaultLimitationType,
const iFeature= NULL_var)
Retrieves the connectedness of the BRep.
Role: Retrieves the connectedness of the BRep. The BRep is not connected when the underlying geometry is made of more than one piece. In this case several BReps have the same label.
The BRep is connected when the underlying geometry is made of exactly one piece.
Parameters:
oConnectedness
[out] The connectedness of the BRep.
iFeature
[in] Search is performed in the body associated with iFeature.
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.
This object is included in the file: CATIMmiUseTopoAccess.h
If needed, your Imakefile.mk should include the module: CATMecModUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.