MEvaluationNodeIterator Class Reference

#include <MEvaluationNodeIterator.h>

Class Description

Provides access to the Evaluation Manager node dirty plug list.

See also

MEvaluationNode

If you need to access the list of dirty plugs in an MEvaluationNode node then use the internal iterator:

MEvaluationNode theNode; for( MEvaluationNodeIterator it = theNode.iterator(); !it.isDone(); it.next() ) { doSomePlugThing( it.plug() ); }

Public Member Functions
	~MEvaluationNodeIterator ()
	Destructor, frees internal resources.
	MEvaluationNodeIterator (const MEvaluationNode &node, MStatus *ReturnStatus=NULL)
	Constructor for iterator over evaluation node's dirty plugs. More...
	MEvaluationNodeIterator (const MEvaluationNodeIterator &it)
	Copy constructor for iterator over evaluation node's dirty plugs. More...
MEvaluationNodeIterator &	operator= (MEvaluationNodeIterator &it)
	Assignment operator. More...
MPlug	plug ()
	Returns the dirty plug at the current iterator position. More...
bool	isDone () const
	Checks to see if the iterator has reached the end of the iteration. More...
void	next ()
	Advances the iterator to the next position in the dirty plug list.
void	reset ()
	Resets the iterator to the first position in the dirty plug list.

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Constructor & Destructor Documentation

MEvaluationNodeIterator	(	const MEvaluationNode &	node,
		MStatus *	ReturnStatus = NULL
	)

Constructor for iterator over evaluation node's dirty plugs.

Parameters

[in]	node	Evaluation node over which to iterate
[out]	ReturnStatus	Status Code

Status Codes:

• MS::kSuccess The operation succeeded
• MS::kFailure Object error - no evaluation node

MEvaluationNodeIterator

(

const MEvaluationNodeIterator &

rhs

)

Copy constructor for iterator over evaluation node's dirty plugs.

The copied iterator is not const because it becomes empty after the copy.

Parameters

[in]

rhs

Iterator to copy

Status Codes:

• MS::kSuccess The operation succeeded
• MS::kFailure Object error - no evaluation node

Member Function Documentation

MEvaluationNodeIterator & operator=

(

MEvaluationNodeIterator &

rhs

)

Assignment operator.

The copied iterator is not const because it becomes empty after the assignment.

Parameters

[in]

rhs

Iterator from which to copy information

Returns

Reference to the assigned iterator

MPlug plug

(

)

Returns the dirty plug at the current iterator position.

Returns an empty plug if the iterator is illegal.

Returns

dirty plug at the current iterator index

bool isDone

(

)

const

Checks to see if the iterator has reached the end of the iteration.

Returns

True if the iteration has completed

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:

• MEvaluationNodeIterator.h
• MEvaluationNodeIterator.cpp