VdfMaskedIterator< IteratorType, mode > Class Template Reference

An iterator that can be used to refine the given iterator IteratorType to iterate over a given mask by either visiting or skipping over set bits in the mask. More...

#include <maskedIterator.h>

Inheritance diagram for VdfMaskedIterator< IteratorType, mode >:

Public Types
typedef IteratorType::value_type	value_type
	The value type of this iterator.
typedef IteratorType::reference	reference
	The dereference type of this iterator.

Public Member Functions
template<typename... Args>
	VdfMaskedIterator (const VdfContext &context, const VdfMask &visitMask, Args &&... args)
	Constructor.
VdfMaskedIterator &	operator++ ()
	Increment operator to point to the next element.
reference	operator* () const
	Returns reference to current element.
bool	IsAtEnd () const
	Returns true if the iterator is done iterating and false otherwise.
void	AdvanceToEnd ()
	Advance the iterator to the end.

Friends
int	Vdf_GetIteratorIndex (const VdfMaskedIterator &it)

Additional Inherited Members
Protected Member Functions inherited from VdfIterator
	~VdfIterator ()=default
	Disallow destruction via base class pointers.
const VdfNode &	_GetNode (const VdfContext &context) const
	Returns the current node being run.
const VdfExecutorInterface &	_GetExecutor (const VdfContext &context) const
	Returns the executor for the given context.
VDF_API const VdfVector *	_GetInputValue (const VdfContext &context, const VdfConnection &connection, const VdfMask &mask) const
	Returns a vector for reading an input value.
VDF_API const VdfVector &	_GetRequiredInputValue (const VdfContext &context, const VdfConnection &connection, const VdfMask &mask) const
	Returns the cached output value for a given output, or issues an error message if a cache value is not available.
VDF_API const VdfOutput *	_GetRequiredOutputForWriting (const VdfContext &context, const TfToken &name) const
	Returns the output for writing based on the name provided.
VDF_API VdfVector *	_GetOutputValueForWriting (const VdfContext &context, const VdfOutput &output) const
	Returns a vector for writing an output value into.
VDF_API bool	_GetOutputMasks (const VdfContext &context, const VdfOutput &output, const VdfMask **requestMask, const VdfMask **affectsMask) const
	Retrieves the request and affects masks of the given output.
VDF_API bool	_IsRequiredInput (const VdfContext &context, const VdfConnection &connection) const
	Returns true when the connection is scheduled and required, and false otherwise.
VDF_API const VdfMask *	_GetRequestMask (const VdfContext &context, const VdfOutput &output) const
	Returns the request mask of output, if the output has been scheduled and NULL otherwise.
VDF_API void	_ForEachScheduledOutput (const VdfContext &context, const VdfNode &node, const VdfScheduledOutputCallback &callback) const
	Loops over each scheduled output of node and calls callback with the output and request mask in an efficient manner.

Detailed Description

template<class IteratorType, VdfMaskedIteratorMode mode>
class VdfMaskedIterator< IteratorType, mode >

An iterator that can be used to refine the given iterator IteratorType to iterate over a given mask by either visiting or skipping over set bits in the mask.

Definition at line 43 of file maskedIterator.h.

Member Typedef Documentation

reference

typedef IteratorType::reference reference

The dereference type of this iterator.

Definition at line 53 of file maskedIterator.h.

value_type

typedef IteratorType::value_type value_type

The value type of this iterator.

Definition at line 49 of file maskedIterator.h.

Constructor & Destructor Documentation

VdfMaskedIterator()

VdfMaskedIterator	(	const VdfContext &	context,
		const VdfMask &	visitMask,
		Args &&...	args
	)

Constructor.

Creates a masked iterator using visitMask and args.

Definition at line 104 of file maskedIterator.h.

Member Function Documentation

AdvanceToEnd()

void AdvanceToEnd ( )

inline

Advance the iterator to the end.

Definition at line 79 of file maskedIterator.h.

IsAtEnd()

bool IsAtEnd ( ) const

inline

Returns true if the iterator is done iterating and false otherwise.

Definition at line 73 of file maskedIterator.h.

operator*()

reference operator* ( ) const

inline

Returns reference to current element.

Definition at line 67 of file maskedIterator.h.

operator++()

VdfMaskedIterator< IteratorType, mode > & operator++

Increment operator to point to the next element.

Definition at line 119 of file maskedIterator.h.

Friends And Related Function Documentation

Vdf_GetIteratorIndex

int Vdf_GetIteratorIndex ( const VdfMaskedIterator< IteratorType, mode > &  it )

friend

Definition at line 86 of file maskedIterator.h.

---

The documentation for this class was generated from the following file:

• pxr/exec/vdf/maskedIterator.h