GMModelInterfaces CATBoundedCellsIterator
Usage: you must use this class as is. You should never derive it.
public class CATBoundedCellsIterator
Class defining an iterator that scans the cells bounded by a cell belonging to a specified Body.
The input cell must belongs to the specified body.
The output bounded cells are also belonging to the specified body.
For example, if the iterator is created for a vertex,
each call to the Next method returns a new cell (whatever its dimension)
that is bounded by the vertex (usually edges, but also faces and volumes
when the vertex is immersed in such higher dimension cells).
This iterator is often created by scan methods on the cells.
When using a CATBoundedCellsIterator on a given body, do not create another one on another one body.
Constructor and Destructor Index
- o
~CATBoundedCellsIterator()
-
Method Index
- o
Duplicate()
- Duplicates this iterator.
- o
GetBody()
- Returns the body inside which the search is done.
- o
GetElement()
- Returns the cell around which the search is done.
- o
Next(CATSide*,CATDomain**)
- Skips to the next bounded cell.
- o
Reset()
- Initializes this iterator to the first cell.
- o
SetElement(CATCell*,CATBody*)
- Defines the context of this iterator.
Constructor and Destructor
o ~CATBoundedCellsIterator
| public virtual ~CATBoundedCellsIterator( | ) |
-
Methods
o Duplicate
| public virtual Duplicate( | ) |
-
Duplicates this iterator.
- Returns:
- A pointer to the created iterator. To delete after use.
o GetBody
-
Returns the body inside which the search is done.
- Returns:
- The pointer to the body.
o GetElement
| public virtual GetElement( | ) |
-
Returns the cell around which the search is done.
- Returns:
- The pointer to the cell.
o Next
| public virtual Next( | | oSide | =NULL, |
| | oDomain | =NULL ) |
-
Skips to the next bounded cell.
- Parameters:
-
- oSide
- The pointer to the corresponding matter side. If NULL in input, this is not output.
- oDomain
- The pointer to the corresponding domain. If NULL in input, this is not output.
- Returns:
- The pointer to the next cell bounded by this, NULL after the last one.
o Reset
-
Initializes this iterator to the first cell.
This allows you to do multiple iterations around the same cell of the given body.
o SetElement
| public virtual SetElement( | | iBoundingCell, |
| | iInBody) |
-
Defines the context of this iterator.
- Parameters:
-
- iBoundingCell
- The pointer to the bounding cell around which the iterator works. It must belong to iInBody.
- iInBody
- The pointer to the body inside which the bounded cells are searched.
This object is included in the file: CATBoundedCellsIterator.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.