GMModelInterfaces CATBoundaryIterator

Usage: you must use this class as is. You should never derive it.


public class CATBoundaryIterator

Class that defines the iterator on the cells that bound a given cell.

This iterator is often returned by scan methods on the cells.


Constructor and Destructor Index


o CATBoundaryIterator()
Constructs an iterator on the bounding cells.
o ~CATBoundaryIterator()

Method Index


o Duplicate()
Duplicates this iterator.
o GetElement()
Returns the cell which bounding cells are asked for.
o Next(CATSide*,CATDomain**,short*)
Skips to the next cell of this iterator.
o Next(CATSide*,CATDomain**,short*,CATPCurve**,CATOrientation*,CATCrvParam*,CATCrvParam*)
Skips to the next bounding cell of a face.
o Reset()
Initializes the iterator at the first cell.
o SetElement(CATCell*)
Defines the cell which boundary are asked for.

Constructor and Destructor


o CATBoundaryIterator
public CATBoundaryIterator()
Constructs an iterator on the bounding cells.
o ~CATBoundaryIterator
public virtual ~CATBoundaryIterator()

Methods


o Duplicate
public virtual Duplicate()
Duplicates this iterator.
Returns:
A pointer to the created iterator. To delete after use.
o GetElement
public virtual GetElement()
Returns the cell which bounding cells are asked for.
Returns:
The pointer to the cell which boundaries are asked for.
o Next
public virtual Next( ioSide=NULL,
oDomain=NULL,
ioNewDomain=NULL )
Skips to the next cell of this iterator.
Parameters:
ioSide
The pointer to the matter side of the next cell. If NULL in input, this is not output.
oDomain
The pointer to the corresponding domain. If NULL in input, this is not output.
ioNewDomain
The dectection of the scan of a new domain.
Legal values: TRUE for the first cell of each new scanned domain, FALSE otherwise.
Returns:
The pointer to the next edge, NULL after the last one.
o Next
public virtual Next( oSide,
oDomain,
oNewDomain,
oPCurve,
oOrientation= NULL,
oStartParam= NULL,
oEndParam= NULL)
Skips to the next bounding cell of a face.
Parameters:
ioSide
The pointer to the matter side of the next edge. If NULL in input, this is not output.
oDomain
The pointer to the corresponding domain. If NULL in input, this is not output.
ioNewDomain
The dectection of the scan of a new loop.
Legal values: TRUE for the first edge of each new scanned loop, FALSE otherwise.
oPCurve
The pointer to the corresponding CATPCurve. If NULL in input, this is not output.
oOrientation
The pointer to the relative orientation of the returned edge with regards to its geometry oPCurve. If NULL in input, this is not output.
oStartParam
A pointer to the low limitation of the returned edge on oPCurve.
oEndParam
A pointer to the high limitation of the returned edge on oPCurve.
Returns:
The pointer to the next edge, NULL after the last one.
o Reset
public virtual Reset()
Initializes the iterator at the first cell.
This allows you to do multiple iterations around the same cell.
o SetElement
public virtual SetElement( iBoundedCell)
Defines the cell which boundary are asked for.
Parameters:
iBoundedCell
The pointer to the cell which boundaries are asked for.

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

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