All Frameworks Class Hierarchy This Framework Indexes Previous Next

DataExchangeBaseRepsItf Interface CATIExchangeLoop

Usage: you can freely reimplement this interface.

interface CATIExchangeLoop

Interface to exchange loops.
Role: This interface is dedicated to get loops properties.
A loop is a mono-dimensional closed edge-made contour.
Available from CATIA V5R10.
Modified CATIA V5R15.

Method Index

o AreThereTwoRepresentations(CATBoolean*): Checks if both representations (2D and 3D) are available.
o EnumEdgeUses(): Returns a list of all edgeuses which make up the loop.
o EnumEdges(): Returns a list of all edges which make up the loop.
o GetPreferredRepresentation(int*): Retrieves the preferred representation of the loop.
o IsOuterLoop(short*): Retrieves TRUE if the loop is an outer one.

Methods

o AreThereTwoRepresentations

public virtual AreThereTwoRepresentations( oBothRepresentations)

Checks if both representations (2D and 3D) are available. (Method Available from CATIA V5R15.)

Parameters:

oBothRepresentations: Gives available representations for loops.
Legal values:
TRUE 2D and 3D Representations are available
FALSE Only one Representation is available (given by GetPreferredRepresentation --> 1 for 2D or 2 for 3D).

Returns:

Returns the success of the computation.
Legal values:
E_FAIL if it is impossible to determinate available representations (for ex: there is neither 2D nor 3D)
S_OK otherwise (successful)

o EnumEdgeUses

public virtual EnumEdgeUses(

)

Returns a list of all edgeuses which make up the loop.

o EnumEdges

public virtual EnumEdges(

)

Returns a list of all edges which make up the loop.

o GetPreferredRepresentation

public virtual GetPreferredRepresentation( oChoice)

Retrieves the preferred representation of the loop. It can be 2D, 3D or unspecified according to sender's preference.
To be called after AreThereTwoRepresentations

Parameters:

oChoice: Get the preferred representation.
Legal values:
0 = not specified, indifferent.
1 = the 2D PCurve is preferred (method GetPCurve of the edgeuse).
2 = the 3D Curve is preferred (method GetCurve of the edge).

o IsOuterLoop

public virtual IsOuterLoop( oIsOuter)

Retrieves TRUE if the loop is an outer one.

Parameters:

oIsOuter: TRUE if the loop is an outer one, FALSE otherwise.

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