GMModelInterfaces CATVertexIterator
Usage: you must use this class as is. You should never derive it.
public class CATVertexIterator
Class defining an iterator that recursively scans (inside the context
of a specified body) the cells that bound a vertex.
The input vertex must belong to the specified Body.
The returned bounded cells belong to the specified body.
This means that this class performs a radial iteration around the vertex,
each call to the Next method returning a new cell
(whatever its dimension) that can be :
- an edge (bounded by the vertex)
- a face (bounded by a domain VertexInFace)
- a face (bounded by an edge that is itself bounded by the vertex)
For instance: the iterator on the
corner of a cube returns by iteration six cells (of the same shell):
Edge1, Face1, Edge2, Face2, Edge3, Face3.
Constructor and Destructor Index
- o
CATVertexIterator(CATTopData*)
- Default constructor.
- o
CATVertexIterator(CATVertexIterator&)
- Copy constructor.
- o
~CATVertexIterator()
-
Method Index
- o
Duplicate()
- Duplicates this CATVertexIterator.
- o
GetBody()
- Returns a pointer to the body inside which this iterator iterates.
- o
GetVertex()
- Returns a pointer to the vertex around which this iterator iterates.
- o
Next(CATSide*,CATDomain**)
- Skips to the next cell of this iterator.
- o
Reset()
- Initializes the iterator.
- o
SetVertex(CATVertex*,CATBody*)
- Defines this vertex iterator.
- o
operator=(CATVertexIterator&)
- Assignment operator.
Constructor and Destructor
o CATVertexIterator
| public CATVertexIterator( | const | iData | = 0) |
-
Default constructor.
- Parameters:
-
- iTopData
- The object defining the CATSoftwareConfiguration and the CATCGMJournalList.
o CATVertexIterator
| public CATVertexIterator( | const | iToCopy) |
-
Copy constructor.
o ~CATVertexIterator
| public virtual ~CATVertexIterator( | ) |
-
Methods
o Duplicate
| public virtual Duplicate( | ) |
-
Duplicates this CATVertexIterator.
- Returns:
- A pointer to the duplicated iterator.
o GetBody
-
Returns a pointer to the body inside which this iterator iterates.
- Returns:
- The pointer to the body.
o GetVertex
| public virtual GetVertex( | ) |
-
Returns a pointer to the vertex around which this iterator iterates.
- Returns:
- The pointer to the vertex.
o Next
| public virtual Next( | | ioSide | =NULL, |
| | ioDomain | =NULL ) |
-
Skips to the next cell of this iterator.
- Parameters:
-
- ioSide
- The side attribute of this with regards to the returned cell.
If NULL, this attribute is not returned.
- ioDomain
- The pointer to the domain to which the returned cell belongs to.
If NULL, this argument is not output.
- Returns:
- The pointer to the next cell of the iterator. NULL after the last cell.
Sample:
CATVertexIterator iter;
iter.SetVertex(AVertex, InsideThisBody);
iter.Reset();
// to only retrieve the next cell
CATCell * nextcell=iter.Next(NULL,NULL);
// to retrieve the cell and more information
CATSide side;
CATDomain * domain;
nextcell=iter.Next(&side,&domain);
o Reset
-
Initializes the iterator.
Allows you to run again the iterations.
o SetVertex
| public virtual SetVertex( | | iVertex, |
| | iBody) |
-
Defines this vertex iterator.
- Parameters:
-
- iVertex
- The pointer to the vertex around which the iteration is done. iVertex
must belong to iBody.
- iBody
- The pointer to the body inside which the iteration is done. As cells can be shared
by several bodies, this argument precises the context of the iteration.
o operator=
| public operator=( | const | iToCopy) |
-
Assignment operator.
This object is included in the file: CATVertexIterator.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.