VdfMask::iterator Class Reference

Iterator class used to iterate through the elements of the mask. More...

#include <mask.h>

Public Types
using	value_type = _BaseIterator::value_type

Public Member Functions
	iterator ()
	Constructs an null iterator that is already at end.
bool	operator== (const iterator &rhs) const
	Returns true if this iterator and rhs compare equal.
bool	operator!= (const iterator &rhs) const
	Returns true if this iterator and rhs do not compare equal.
value_type	operator* () const
	Returns the index of the current element.
iterator &	operator++ ()
	Increment the iterator to the next element.
bool	IsAtEnd () const
	Returns true if the iteration is finished.
void	AdvanceToEnd ()
	Advance the iterator to the end.
int	AdvanceTo (value_type index)
	Advance the iterator to the first index that is set in the mask located at or after index.

Friends
class	VdfMask

Detailed Description

Iterator class used to iterate through the elements of the mask.

Definition at line 399 of file mask.h.

Member Typedef Documentation

value_type

using value_type = _BaseIterator::value_type

Definition at line 403 of file mask.h.

Constructor & Destructor Documentation

iterator()

iterator ( )

inline

Constructs an null iterator that is already at end.

Definition at line 407 of file mask.h.

Member Function Documentation

AdvanceTo()

int AdvanceTo ( value_type  index )

inline

Advance the iterator to the first index that is set in the mask located at or after index.

Definition at line 449 of file mask.h.

AdvanceToEnd()

void AdvanceToEnd ( )

inline

Advance the iterator to the end.

Definition at line 442 of file mask.h.

IsAtEnd()

bool IsAtEnd ( ) const

inline

Returns true if the iteration is finished.

Definition at line 436 of file mask.h.

operator!=()

bool operator!= ( const iterator &  rhs ) const

inline

Returns true if this iterator and rhs do not compare equal.

Definition at line 417 of file mask.h.

operator*()

value_type operator* ( ) const

inline

Returns the index of the current element.

Definition at line 423 of file mask.h.

operator++()

iterator & operator++ ( )

inline

Increment the iterator to the next element.

Definition at line 429 of file mask.h.

operator==()

bool operator== ( const iterator &  rhs ) const

inline

Returns true if this iterator and rhs compare equal.

Definition at line 411 of file mask.h.

Friends And Related Function Documentation

VdfMask

friend class VdfMask

friend

Definition at line 472 of file mask.h.

---

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

• pxr/exec/vdf/mask.h