All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

MecModInterfaces Interface CATIBRepAccess

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ObjectModelerBase.CATILinkableObject
        |
        +---CATIBRepAccess
 

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


interface CATIBRepAccess

Interface to manage a selecting object.
The selecting objects:
@ref CATIRSur, @ref CATIBorderREdge, @ref CATIWireREdge and @ref CATIBorderFVertex are directely named in the generic naming graph.
The selecting objects:

See also:
CATIMfBRepFactory, CATIFeaturize, CATIMfProcReport


Method Index


o CreateBody()
Returns the body created with cells followed in the generic naming graph.
o CreateBody(CATISpecObject_var&,CATMfBRepType)
Creates the body created with cells associated with the selecting object.
o GetAncestors(CATISpecObject_var&,CATMfNodeReportType)
Returns the grandparents of the selecting object.
o GetBRepElementType()
Reads the selecting object type.
o GetBReps()
Returns the selecting objects with the same topological dimension.
o GetBReps(CATISpecObject_var&,CATMfBRepType)
Returns selecting objects with the same topological dimension.
o GetBReps(CATISpecObject_var&,int,CATMfBRepType)
Returns selecting objects according to a specified dimension.
o GetBReps(int)
Returns selecting objects according to a specified dimension.
o GetCells()
Returns the cells associated with the selecting object.
o GetCells(CATISpecObject_var&,CATMfBRepType)
Returns the cells associated with the children nodes of the selecting object.
o GetCells(CATISpecObject_var&,int,CATMfBRepType)
Returns the cells with a specified dimension and associated with the selecting object.
o GetCells(int)
Returns the cells with a specified dimension and associated with the selecting object.
o GetConnexity()
Returns the connectivity of a selecting object.
o GetConnexity(CATISpecObject_var&,CATMfBRepType)
Returns the connectivity of a selecting object.
o GetDimension()
Returns the topological dimension of a selecting object.
o GetGeometries(CATISpecObject_var&,CATLISTV(CATBaseUnknown_var)&)
Returns the cells associated with the selecting object.
o GetGeometries(CATLISTV(CATBaseUnknown_var)&)
Returns the Geometry associated to a selecting object.
o GetInitialFeature()
Returns the youngest feature according to the history of the mechanical part, that generated the selecting object.
o GetInitialFeature(CATMfNodeReportType)
Returns the oldest feature, according to the history of the mechanical part, that generated the selecting object.
o GetInitialMasterFeature()
Returns the visible feature that generated the selecting object.
o GetLastFeature()
Returns the feature that generated the selecting object.
o GetMechanicalExtendedLabel(CATISpecObject_var&,CATMfBRepType)
Creates the extended label.
o GetNecessaryFeatures()
Returns the features involved in the selecting object definition.
o GetNecessaryFeatures(CATMfBRepType)
Returns the features involved in the selecting object definition.
o GetSelectingBody()
Returns the body that contains the selected cell.
o GetSelectingCell()
Returns the selected cell.
o GetSelectingFeature()
Returns the feature containing the selected object.
o GetSelectingHighDimension()
Returns the high topological dimension of the domain that contains the selected cell.
o GetSelectingLowDimension()
Returns the low topological dimension of the domain that contains the selected cell.
o GetSelectingMasterFeature()
Returns the parent feature of the feature containing the selected object.
o GetValidity()
Reads the object validity.
o IsABRep(CATMfBRepAccessElementType)
Reads the selecting object type status.
o IsImpactedBy(CATISpecObject_var&)
Analyses if the selecting object involves a specified feature.
o IsImpactedBy(CATISpecObject_var&,CATMfBRepType)
Analyses if the selecting object involves a specified feature.
o IsInfinite()
Returns the infinite property of a selecting object.
o IsSame(CATIBRepAccess_var&)
Returns 1 if the selecting objects are same.
o IsSameLabel(CATIBRepAccess_var&,CATMfBRepType)
Returns 1 if the labels of selecting objects are same.
o IsSolvable(CATISpecObject_var&,CATMfBRepType)
Returns 1 if the the selecting object can be solved in the body of the ResultOUT of iFeature object.
o IsValid()
Reads the object validity status.
o ResolveFaces(CATISpecObject_var&,CATListOfInt&,CATMfBRepType)
Returns the faces associated to a selecting object.
o ResolveFaces(CATListOfInt&)
Returns the associated faces followed by the generic naming graph.
o UnGroup(CATISpecObject_var&,CATMfNodeReportType)
Returns the children of the selecting object in the generic naming graph.

Methods


o CreateBody
public virtual CATBody_var CreateBody()=0
Returns the body created with cells followed in the generic naming graph.
Throws:
CATError
o CreateBody
public virtual CATBody_var CreateBody( const CATISpecObject_var& iFeature,
const CATMfBRepType iBRepType= MfDefaultBRepType)=0
Creates the body created with cells associated with the selecting object.
Parameters:
iFeature
Search is performed in the body associated with iFeature.
Throws:
CATError
o GetAncestors
public virtual CATLISTP(CATIBRepAccess) GetAncestors( const CATISpecObject_var& iFeature= NULL_var,
const CATMfNodeReportType iType= MfModification) const = 0
Returns the grandparents of the selecting object.
Parameters:
iFeature
Search in performed in the iFeature body, in the whole generic naming graph if iFeature is NULL.
iType
Legal values: MfModification, MfCovering, MfGeneration specifies the search strategy.
Throws:
CATError
o GetBRepElementType
public virtual CATMfBRepAccessElementType GetBRepElementType()= 0
Reads the selecting object type.
Returns:
Legal values: MfRSur, MfREdge, MfFVertex, MfBorderREdge, MfBorderFVertex, MfWireREdge, MfWireFVertex, MfAxis, MfExtremity, MfPlanarSubElement, MfUnknownElementType
Throws:
CATError
o GetBReps
public virtual CATLISTV(CATBaseUnknown_var) GetBReps()= 0
Returns the selecting objects with the same topological dimension. All these selecting objects have the same label, they cannot be distinguished from each other.
Throws:
CATError
o GetBReps
public virtual CATLISTV(CATBaseUnknown_var) GetBReps( const CATISpecObject_var& iFeature,
const CATMfBRepType iBRepType= MfDefaultBRepType)= 0
Returns selecting objects with the same topological dimension. All these selecting objects have the same label, they cannot be distinguished from each other.
Parameters:
iFeature
Search is performed in the body associated with iFeature.
iBRepType
either MfFunctional to get all the elements with same underlying geometry or MfDefaultBRepType.
Throws:
CATError
o GetBReps
public virtual CATLISTV(CATBaseUnknown_var) GetBReps( const CATISpecObject_var& iFeature,
const int iDim,
const CATMfBRepType iBRepType= MfDefaultBRepType)= 0
Returns selecting objects according to a specified dimension.
Parameters:
iFeature
Search is performed in the body associated with iFeature.
iDim
Topological dimension of search objects.
iBRepType
either MfFunctional to get all the elements with same underlying geometry or MfDefaultBRepType.
Throws:
CATError
o GetBReps
public virtual CATLISTV(CATBaseUnknown_var) GetBReps( const int iDim)= 0
Returns selecting objects according to a specified dimension.
Parameters:
iDim
Topological dimension of search objects.
Throws:
CATError
o GetCells
public virtual CATLISTV(CATBaseUnknown_var) GetCells()= 0
Returns the cells associated with the selecting object.
Throws:
CATError
o GetCells
public virtual CATLISTV(CATBaseUnknown_var) GetCells( const CATISpecObject_var& iFeature,
const CATMfBRepType iBRepType= MfDefaultBRepType) = 0
Returns the cells associated with the children nodes of the selecting object.
Parameters:
iFeature
Search is performed in the body associated with iFeature.
iBRepType
either MfFunctional to get all the elements with same underlying geometry or MfDefaultBRepType.
Throws:
CATError
o GetCells
public virtual CATLISTV(CATBaseUnknown_var) GetCells( const CATISpecObject_var& iFeature,
const int iDim,
const CATMfBRepType iBRepType= MfDefaultBRepType)= 0
Returns the cells with a specified dimension and associated with the selecting object.
Parameters:
iFeature
Search is performed in the bidy associated with iFeature.
iDim
0 for vertices, 1 for edges or 2 for faces.
iBRepType
either MfFunctional to get all the elements with same underlying geometry or MfDefaultBRepType.
Throws:
CATError
o GetCells
public virtual CATLISTV(CATBaseUnknown_var) GetCells( const int iDim)= 0
Returns the cells with a specified dimension and associated with the selecting object.
Parameters:
iDim
0 for vertices, 1 for edges or 2 for faces.
Throws:
CATError
o GetConnexity
public virtual CATMfConnexityType GetConnexity()= 0
Returns the connectivity of a selecting object.
The selecting object is not connected when the underlying geometry is made of more than one piece. In this case several selecting objects have the same label.
The selecting object is connected when the underlying geometry is made of exactly one piece.
Returns:
Legal values: MfNoConnex when it is not connected, MfConnex when it is connected, MfUnknownConnexity when the connectivity status is unknown.
Throws:
CATError
o GetConnexity
public virtual CATMfConnexityType GetConnexity( const CATISpecObject_var& iFeature,
const CATMfBRepType iBRepType= MfDefaultBRepType)= 0
Returns the connectivity of a selecting object.
The selecting object is not connected when the underlying geometry is made of more than one piece. In this case several selecting objects have the same label.
The selecting object is connected when the underlying geometry is made of exactly one piece.
Parameters:
iFeature
Search is performed in the body associated with iFeature.
iBRepType
either MfFunctional to get all the elements with same underlying geometry or MfDefaultBRepType.
Returns:
Legal values: MfNoConnex when it is not connected, MfConnex when it is connected, MfUnknownConnexity when the connectivity status is unknown.
Throws:
CATError
o GetDimension
public virtual int GetDimension()const = 0
Returns the topological dimension of a selecting object.
Returns:
Legal values: 0 for a vertex, 1 for an edge or 2 for a face.
Throws:
CATError
o GetGeometries
public virtual int GetGeometries( const CATISpecObject_var& iFeature,
CATLISTV(CATBaseUnknown_var)& oGeometries) =0
Returns the cells associated with the selecting object.
Parameters:
iFeature
Search is performed in the body associated with iFeature.
oGeometries
Geometrical elements associated with the selecting object.
Throws:
CATError
o GetGeometries
public virtual int GetGeometries(CATLISTV(CATBaseUnknown_var)& oGeometries) =0
Returns the Geometry associated to a selecting object.
Parameters:
oGeometries
Geometrical elements associated with the selecting object.
Throws:
CATError
o GetInitialFeature
public virtual CATISpecObject_var GetInitialFeature()const = 0
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.
Throws:
CATError
o GetInitialFeature
public virtual CATISpecObject_var GetInitialFeature( const CATMfNodeReportType iSearchType) const = 0
Returns the oldest feature, according to the history of the mechanical part, that generated the selecting object. Searching strategy starts from the current feature of the part and goes back in time through the part history according to the input parameter. This is an advanced method.
Parameters:
iSearchType
Legal values:
With MfModification, the returned feature is the oldest one that generated the selecting object. The search stops at a mirror, draft angle or thickness feature, even if the source feature is younger. For example, the returned feature is the thickness if the selecting object is the thicked lateral face of a pad. This is the default strategy of the previous methods.
With MfCovering, the search goes beyond mirror, draft angle and thickness. For example, the returned feature is the pad if the selecting object is a thicked lateral face of the pad.
With MfGeneration, the returned feature is searched through mirror, draft angle, thickness and up to the highest root. For example, if the selecting object is the thicked lateral face of the pad, the returned feature is the curve in the sketch of the pad from which the lateral face is built.
Throws:
CATError
o GetInitialMasterFeature
public virtual CATISpecObject_var GetInitialMasterFeature()const = 0
Returns the visible feature that generated the selecting object. Returns the youngest feature according to the history of the mechanical part, that generated the selecting object and that is displayed in the specification tree.
Throws:
CATError
o GetLastFeature
public virtual CATISpecObject_var GetLastFeature()const = 0
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.
Throws:
CATError
o GetMechanicalExtendedLabel
public virtual CATUnicodeString GetMechanicalExtendedLabel( const CATISpecObject_var& iFeature,
const CATMfBRepType iBRepType) const= 0
Creates the extended label.
Parameters:
iFeature
Support feature.
iBRepType
Legal values: MfRelimited, MfFunctional.
Throws:
CATError
o GetNecessaryFeatures
public virtual CATLISTV(CATISpecObject_var) GetNecessaryFeatures()const =0
Returns the features involved in the selecting object definition.
Throws:
CATError
o GetNecessaryFeatures
public virtual CATLISTV(CATISpecObject_var) GetNecessaryFeatures( const CATMfBRepType iBRepType) const =0
Returns the features involved in the selecting object definition.
Parameters:
iBRepType
Legal values: MfFunctional, MfRelimited is the default value if iBRepType parameter is not specified.
Throws:
CATError
o GetSelectingBody
public virtual CATBody_var GetSelectingBody()const =0
Returns the body that contains the selected cell.
Throws:
CATError
o GetSelectingCell
public virtual CATCell_var GetSelectingCell()const =0
Returns the selected cell.
o GetSelectingFeature
public virtual CATISpecObject_var GetSelectingFeature()const = 0
Returns the feature containing the selected object.
If this feature is a ResultOUT, it is not displayed in the specification tree.
Throws:
CATError
o GetSelectingHighDimension
public virtual short GetSelectingHighDimension()const = 0
Returns the high topological dimension of the domain that contains the selected cell.
Returns:
Returns 1 for a wire, 2 for a shell, 3 for a lump, -1 if the dimension cannot be computed.
Throws:
CATError
o GetSelectingLowDimension
public virtual short GetSelectingLowDimension()const = 0
Returns the low topological dimension of the domain that contains the selected cell.
Returns:
Returns 1 for a wire, 2 for a shell, 3 for a lump, -1 if the dimension cannot be computed.
Throws:
CATError
o GetSelectingMasterFeature
public virtual CATISpecObject_var GetSelectingMasterFeature()const = 0
Returns the parent feature of the feature containing the selected object. This feature is displayed in the specification tree.
Throws:
CATError
o GetValidity
public virtual CATBoolean GetValidity()const = 0
Reads the object validity.
Returns:
Returns True if the selecting object is correctly named by the generic naming.
o IsABRep
public virtual int IsABRep( const CATMfBRepAccessElementType iType) = 0
Reads the selecting object type status.
Parameters:
iType
Legal values: MfRSur, MfREdge, MfFVertex, MfBorderREdge, MfBorderFVertex, MfWireREdge, MfWireFVertex, MfAxis, MfExtremity, MfPlanarSubElement, MfUnknownElementType
Returns:
Returns 1 if iType is the correct type, 0 if iType is not.
Throws:
CATError
o IsImpactedBy
public virtual int IsImpactedBy( const CATISpecObject_var& iFeature) const = 0
Analyses if the selecting object involves a specified feature. If the specified feature is deleted, the selecting object becomes invalid.
Parameters:
iFeature
Design feature.
Throws:
CATError
o IsImpactedBy
public virtual int IsImpactedBy( const CATISpecObject_var& iFeature,
const CATMfBRepType iBRepType) const = 0
Analyses if the selecting object involves a specified feature. If the specified feature is deleted, the selecting object becomes invalid.
Parameters:
iFeature
Design feature.
iBRepType
Legal values: MfFunctional, MfRelimited is the default value if iBRepType parameter is not specified.
Throws:
CATError
o IsInfinite
public virtual CATBoolean IsInfinite()=0
Returns the infinite property of a selecting object.
Returns:
The infinity mode of this.
Legal values: TRUE, if this must be considered as infinite, FALSE if it is finite (default mode).
Throws:
CATError
o IsSame
public virtual int IsSame( const CATIBRepAccess_var& iBrep) const = 0
Returns 1 if the selecting objects are same.
Parameters:
iBrep
Selecting object to be compared.
o IsSameLabel
public virtual int IsSameLabel( const CATIBRepAccess_var& iBrep,
const CATMfBRepType iBRepType= MfDefaultBRepType) const = 0
Returns 1 if the labels of selecting objects are same.
Parameters:
iBrep
Selecting object to be compared.
iBRepType
BRep type.
o IsSolvable
public virtual int IsSolvable( const CATISpecObject_var& iFeature,
const CATMfBRepType iBRepType= MfDefaultBRepType) = 0
Returns 1 if the the selecting object can be solved in the body of the ResultOUT of iFeature object.
Parameters:
iFeature
Solving is performed in the body of the ResultOUT of iFeature object.
iBRepType
either MfFunctional to get all the elements with same underlying geometry or MfDefaultBRepType.
o IsValid
public virtual CATBoolean IsValid()const = 0
Reads the object validity status.
Returns:
Returns True if the selecting object is correctly named by the generic naming.
o ResolveFaces
public virtual CATLISTV(CATBaseUnknown_var) ResolveFaces( const CATISpecObject_var& iFeature,
CATListOfInt& oCardList,
const CATMfBRepType iBRepType= MfDefaultBRepType) = 0
Returns the faces associated to a selecting object.
Parameters:
iFeature
Search is performed in the body associated with iFeature.
oCardList
If the selecting object is a
CATIRSur then oCardList[1] is the number of faces.
If the selecting object is a CATIREdge then oCardList[1] is the number of adjacent left faces and oCardList[2] is the number of adjacent right faces.
If the selecting object is a CATIFVertex then oCardList[i] is the number of faces adjacent to the vertex, faces that are trimmed pieces of the same initial face.
If the selecting object is a CATIBorderREdge 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.
iBRepType
Specify the way the serach is to be processed. MfFunctional to get all the elements with same underlying geometry or MfDefaultBRepType can be specified according to the needs.
Returns:
Returns an empty list if the selecting object is a CATIBorderFVertex, a CATIWireREdge or a CATIWireFVertex since they never have any adjacent faces.
Throws:
CATError
o ResolveFaces
public virtual CATLISTV(CATBaseUnknown_var) ResolveFaces(CATListOfInt& oCardList) = 0
Returns the associated faces followed by the generic naming graph.
Parameters:
oCardList
If the selecting object is a
CATIRSur then oCardList[1] is the number of faces.
If the selecting object is a CATIREdge then oCardList[1] is the number of adjacent left faces and oCardList[2] is the number of adjacent right faces.
If the selecting object is a CATIFVertex then oCardList[i] is the number of faces adjacent to the vertex, faces that are trimmed pieces of the same initial face.
If the selecting object is a CATIBorderREdge 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. * @return Returns an empty list if the selecting object is a CATIBorderFVertex, a CATIWireREdge or a CATIWireFVertex since they never have any adjacent faces.
Throws:
CATError
o UnGroup
public virtual CATLISTP(CATIBRepAccess) UnGroup( const CATISpecObject_var& iInFeature= NULL_var,
const CATMfNodeReportType iType= MfModification) const = 0
Returns the children of the selecting object in the generic naming graph.
Parameters:
iFeature
Search is performed at the iFeature level; in the whole generic naming graph if iFeature is NULL.
iType
Legal values: MfModification, MfCovering, MfGeneration specifies the search strategy.
Throws:
CATError

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

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