CATMecModUseItf Interface CATIMmiUseGeometryAccess

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

interface CATIMmiUseGeometryAccess

Interface to get selecting objects and topological cells through generic naming or symbolic information.
Methods of this interfaces are called on a source shape feature. They retrieve selecting objects or topological cells from the specified source shape feature, a key word iKey, if needed, a profile element iProfileElement of a sketch, and a iFeature to specify the search domain.
For example, the CATIMmiUseRsur selecting objects associated with the lateral face of Pad.3 extruded from Line.7 are found with Pad.3->GetBReps(MfKeyExtrudedFrom,Line.7,List). Without any iFeature, the search is performed on the source solid (Pad.3 in the previous example). The instruction Pad.3->GetBReps(MfKeyExtrudedFrom,Line.7,Fillet.6,List) finds the CATIMmiUseRsur selecting objects associated with the lateral face of Pad.3 extruded from Line.7 on the solid after Fillet.6.
Another example, the face BRep feature associated with the top face of Pad.6 is found with Pad.6->GetBReps(MfKeyTop,List).
The instruction Fillet.3->GetCells(List) retrieves the Fillet.3 faces, and the instruction Fillet.3->GetCells(Draft.12,List) retrieves the Fillet.3 faces as they appear on the solid after Draft.12.
Legal values:

  • MfKeyTop available for a pad, a pocket, a rib, a slot, a stiffener,
  • MfKeyBottom available for a pad, a pocket, a rib, a slot, a stiffener,
  • MfKeyExtrudedFrom available for a pad, a pocket, a rib, a slot, a stiffener, a shaft, a groove,
  • MfKeyStart available for a shaft, a groove,
  • MfKeyEnd available for a shaft, a groove.

    Method Index


    o GetBReps(CATListValCATIMmiUseBRepAccess_var&,CATIMmiUseGeometricalElement_var&)
    Retrieves all the selecting objects.
    o GetBReps(CATUnicodeString&,CATListValCATIMmiUseBRepAccess_var&,CATIMmiUseGeometricalElement_var&)
    Retrieves selecting objects from symbolic information.
    o GetBReps(CATUnicodeString&,CATBaseUnknown_var&,CATListValCATIMmiUseBRepAccess_var&,CATIMmiUseGeometricalElement_var&)
    Retrieves all the selecting objects from symbolic information.
    o GetBReps(CATUnicodeString&,CATBaseUnknown_var&,CATBaseUnknown_var&,CATListValCATIMmiUseBRepAccess_var&,CATIMmiUseGeometricalElement_var&)
    Retrieves selecting objects from symbolic information.
    o GetFilteredBReps(CATListValCATIMmiUseBRepAccess_var&,CATMmiDimension,CATMmrBRepFilterType,CATIMmiUseGeometricalElement_var&)
    Retrieves all the selecting objects.
    o GetTopoCells(CATLISTV(CATBaseUnknown_var)&,CATIMmiUseGeometricalElement_var&)
    Retrieves all the topological cells.
    o GetTopoCells(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&,CATIMmiUseGeometricalElement_var&)
    Retrieves topological faces from symbolic information.
    o GetTopoCells(CATUnicodeString&,CATBaseUnknown_var&,CATLISTV(CATBaseUnknown_var)&,CATIMmiUseGeometricalElement_var&)
    Retrieves topological faces from symbolic information.
    o GetTopoCells(CATUnicodeString&,CATBaseUnknown_var&,CATBaseUnknown_var&,CATLISTV(CATBaseUnknown_var)&,CATIMmiUseGeometricalElement_var&)
    Retrieves topological faces from symbolic information.

    Methods


    o GetBReps
    public virtual GetBReps( oBreps,
    const iFeature= NULL_var)
    Retrieves all the selecting objects.
    Parameters:
    oBreps
    [out] List of selecting objects. Query CATIMmiUseBRepAccess or its derived interfaces.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetBReps
    public virtual GetBReps( const iKey,
    oBreps,
    const iFeature= NULL_var)
    Retrieves selecting objects from symbolic information.
    Parameters:
    iKey
    [in] Key word.
    Legal values:
    • MfKeyTop, MfKeyBottom: available for a pad, a pocket, a rib, a slot, a stiffener,
    • MfKeyStart, MfKeyEnd: available for a shaft, a groove.
    oBreps
    [out] List of CATIMmiUseRsur selecting objects.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetBReps
    public virtual GetBReps( const iKey,
    const iProfileElement,
    oBreps,
    const iFeature= NULL_var)
    Retrieves all the selecting objects from symbolic information. Available for lateral faces of an extruded or revolute shape feature: a pad, a pocket, a shaft, a groove, a stiffener.
    Parameters:
    iKey
    [in] Key word.
    Legal values: MfKeyExtrudedFrom.
    iProfileElement
    [in] Profile element.
    oBreps
    [out] List of CATIMmiUseRsur selecting objects.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetBReps
    public virtual GetBReps( const iKey,
    const iProfileElement1,
    const iProfileElement2,
    oBreps,
    const iFeature= NULL_var)
    Retrieves selecting objects from symbolic information. Available for lateral faces of a swept shape feature: a rib, a slot.
    Parameters:
    iKey
    [in] Key word.
    Legal values: MfKeyExtrudedFrom
    iProfileElement1
    [in] First profile element.
    iProfileElement2
    [in] Second profile element.
    oBreps
    [out] List of CATIMmiUseRsur selecting objects.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetFilteredBReps
    public virtual GetFilteredBReps( oLBreps,
    const iDim= CATMmiDimUnknown,
    const iFilterType= CATMmrWithSelectingCell,
    const iFeature= NULL_var)
    Retrieves all the selecting objects.
    Parameters:
    oBreps
    [out] List of selecting objects. Query CATIMmiUseBRepAccess or its derived interfaces.
    iDim
    [in] the selecting object retrived will be of iDim dimension (
    ).
    iFilterType
    [in] the number of selecting object retrived will be of one for every cell with CATMmrWithSelectingCell option, and will be minimum with CATMmrWithoutSelectingCell, as cells with the same naming will share the same selecting object. For exemple one a Cylinder you will retrive 2 selecting objects with CATMmrWithSelectingCell option and only 1 with the other option.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetTopoCells
    public virtual GetTopoCells( oCells,
    const iFeature= NULL_var)
    Retrieves all the topological cells.
    Parameters:
    oCells
    [out] List of cells. Query CATCell or its derived interfaces.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetTopoCells
    public virtual GetTopoCells( const iKey,
    oCells,
    const iFeature= NULL_var)
    Retrieves topological faces from symbolic information.
    Parameters:
    iKey
    [in] Key word.
    Legal values:
    • MfKeyTop, MfKeyBottom: available for a pad, a pocket, a rib, a slot, a stiffener,
    • MfKeyStart, MfKeyEnd: available for a shaft, a groove.
    oCells
    [out] List of CATFace cells.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetTopoCells
    public virtual GetTopoCells( const iKey,
    const iProfileElement,
    oCells,
    const iFeature= NULL_var)
    Retrieves topological faces from symbolic information. Available for lateral faces of an extruded or revolute shape feature: a pad, a pocket, a shaft, a groove.
    Parameters:
    iKey
    [in] Key word.
    Legal values: MfKeyExtrudedFrom
    iProfileElement
    [in] Profile element.
    oCells
    [out] List of CATFace cells.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    o GetTopoCells
    public virtual GetTopoCells( const iKey,
    const iProfileElement1,
    const iProfileElement2,
    oCells,
    const iFeature= NULL_var)
    Retrieves topological faces from symbolic information. Available for lateral faces of a swept shape feature: a rib, a slot.
    Parameters:
    iKey
    [in] Key word.
    Legal values: MfKeyExtrudedFrom
    iProfileElement1
    [in] First profile element.
    iProfileElement2
    [in] Second profile element.
    oCells
    [out] List of CATFace cells.
    iFeature
    [in] Search is performed at the level of iFeature.
    Returns:
    S_OK
    Successful.
    E_FAIL
    In case of error.
    This object is included in the file: CATIMmiUseGeometryAccess.h
    If needed, your Imakefile.mk should include the module: CATMecModUseItf

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