Provides access to the cluster nodes in a given evaluation graph.
More...
#include <MGraphNodeIterator.h>
Constructor.
- Parameters
-
[in] | cluster | an evaluation cluster. A cluster is a grouping of nodes within the Evaluation Graph that are evaluated together as a single unit. The iterator will point to the root of the cluster. |
[out] | ReturnStatus | return status |
- Status Codes:
- MS::kSuccess the operation succeeded
- MS::kFailure the operation failed (the provided cluster object is possibly invalid)
Constructor.
- Parameters
-
[in] | iterator | another graph iterator object |
[out] | ReturnStatus | return status |
- Status Codes:
- MS::kSuccess the operation succeeded
- MS::kFailure the operation failed (internal failure)
bool isDone |
( |
MStatus * |
ReturnStatus = NULL | ) |
const |
Checks to see if the iterator has reached the end of the iteration.
- Parameters
-
[out] | ReturnStatus | return status |
- Returns
- True if the iteration has completed
- Status Codes:
- MS::kSuccess the operation succeeded
- MS::kFailure the operation failed (the iterator object is possibly invalid)
Returns the evaluation node at the current iterator position.
Returns NULL if the iterator is illegal.
- Parameters
-
[out] | ReturnStatus | return status |
- Returns
- evaluation node at current position
- Status Codes:
- MS::kSuccess the operation succeeded
- MS::kFailure the operation failed (internal failure)
void next |
( |
MStatus * |
ReturnStatus = NULL | ) |
const |
Advances the iterator to the next position in its evaluation graph.
- Parameters
-
[out] | ReturnStatus | return status |
- Status Codes:
- MS::kSuccess the operation succeeded
- MS::kFailure the operation failed (internal failure)
void reset |
( |
MStatus * |
ReturnStatus = NULL | ) |
|
Resets the iterator to the first position in its evaluation graph.
- Parameters
-
[out] | ReturnStatus | return status |
- Status Codes:
- MS::kSuccess the operation succeeded
- MS::kFailure the operation failed (internal failure)
const char * className |
( |
| ) |
|
|
static |
Returns the name of this class.
- Returns
- Name of this class.
The documentation for this class was generated from the following files:
- MGraphNodeIterator.h
- MGraphNodeIterator.cpp