Scheduling cluster representing a self-contained cluster of work.
More...
#include <MCustomEvaluatorClusterNode.h>
Available Scheduling Types.
Enumerator |
---|
kSerial |
Any number of nodes of the same type can run in parallel,.
|
kGloballySerial |
Node should be serialized locally, by chaining all nodes of this flag for sequential execution.
|
kUntrusted |
Only one node of this type can be run at a time.
|
kLast |
Node will do things that can't be predicted and nothing else can be scheduled to execute together with it.
Just to mark the scheduling type count
|
Get the evaluator responsible for this cluster node.
- Parameters
-
[out] | ReturnStatus | Status flag |
- Returns
- The evaluator for this object.
- Status Codes:
- MS::kSuccess operation successful
- MS::kFailure operation failed (evaluator does not exist)
Get the graph that this node is a part of.
- Parameters
-
[out] | ReturnStatus | Status flag |
- Returns
- The cluster node's graph.
- Status Codes:
- MS::kSuccess operation successful
- MS::kFailure operation failed (evaluator or graph do not exist)
void evaluate |
( |
MStatus * |
ReturnStatus = NULL | ) |
const |
Evaluate a single node in this cluster.
- Note
- In some cases, it can be useful when a user wants to change the order of evaluation of nodes inside the given cluster, or skip some nodes entirely. Note that this method should only be used on nodes that are members of the provided cluster.
- Parameters
-
[in] | node | An evaluation node that is a member of the cluster |
[out] | ReturnStatus | Status flag |
- Returns
- None
- Status Codes:
- MS::kSuccess operation successful
- MS::kFailure operation failed (evaluator or graph do not exist)
- Examples:
- constraintEvaluator/constraintEvaluator.cpp.
Provide the MObject for this cluster.
- Note
- Provides the MObject of this cluster, which can be used by MObjectHandle to uniquely identify the cluster object.
- Parameters
-
[out] | ReturnStatus | Status flag |
- Returns
- An MObject for this cluster
- Status Codes:
- MS::kSuccess operation successful
- MS::kFailure operation failed (evaluator or graph do not exist)
const char * className |
( |
| ) |
|
|
static |
Returns the name of this class.
- Returns
- The name of this class.
The documentation for this class was generated from the following files:
- MCustomEvaluatorClusterNode.h
- MCustomEvaluatorClusterNode.cpp