PcpPrimIterator Class Reference

Object used to iterate over prim specs in the prim index graph in strong-to-weak order. More...

#include <iterator.h>

Public Types
using	iterator_category = std::random_access_iterator_tag
using	value_type = SdfSite
using	reference = SdfSite
using	pointer = _PtrProxy
using	difference_type = std::ptrdiff_t

Public Member Functions
PCP_API	PcpPrimIterator ()
	Constructs an invalid iterator.
PCP_API	PcpPrimIterator (const PcpPrimIndex *primIndex, size_t pos)
	Constructs a prim iterator beginning at position pos in the prim stack of prim index primIndex.
PCP_API PcpNodeRef	GetNode () const
	Returns the PcpNode from which the current prim originated.
PCP_API Pcp_SdSiteRef	_GetSiteRef () const
reference	operator* () const
pointer	operator-> () const
reference	operator[] (const difference_type index) const
difference_type	operator- (const PcpPrimIterator &other) const
PcpPrimIterator &	operator++ ()
PcpPrimIterator &	operator-- ()
PcpPrimIterator	operator++ (int)
PcpPrimIterator	operator-- (int)
PcpPrimIterator	operator+ (const difference_type increment) const
PcpPrimIterator	operator- (const difference_type decrement) const
PcpPrimIterator &	operator+= (const difference_type increment)
PcpPrimIterator &	operator-= (const difference_type decrement)
bool	operator== (const PcpPrimIterator &other) const
bool	operator!= (const PcpPrimIterator &other) const
bool	operator< (const PcpPrimIterator &other) const
bool	operator<= (const PcpPrimIterator &other) const
bool	operator> (const PcpPrimIterator &other) const
bool	operator>= (const PcpPrimIterator &other) const

Detailed Description

Object used to iterate over prim specs in the prim index graph in strong-to-weak order.

Definition at line 202 of file iterator.h.

Member Typedef Documentation

difference_type

using difference_type = std::ptrdiff_t

Definition at line 217 of file iterator.h.

iterator_category

using iterator_category = std::random_access_iterator_tag

Definition at line 213 of file iterator.h.

pointer

using pointer = _PtrProxy

Definition at line 216 of file iterator.h.

reference

using reference = SdfSite

Definition at line 215 of file iterator.h.

value_type

using value_type = SdfSite

Definition at line 214 of file iterator.h.

Constructor & Destructor Documentation

PcpPrimIterator() [1/2]

PCP_API PcpPrimIterator

(

)

Constructs an invalid iterator.

PcpPrimIterator() [2/2]

PCP_API PcpPrimIterator	(	const PcpPrimIndex *	primIndex,
		size_t	pos
	)

Constructs a prim iterator beginning at position pos in the prim stack of prim index primIndex.

Member Function Documentation

GetNode()

PCP_API PcpNodeRef GetNode

(

)

const

Returns the PcpNode from which the current prim originated.

operator!=()

bool operator!= ( const PcpPrimIterator &  other ) const

inline

Definition at line 297 of file iterator.h.

operator*()

reference operator* ( ) const

inline

Definition at line 237 of file iterator.h.

operator+()

PcpPrimIterator operator+ ( const difference_type  increment ) const

inline

Definition at line 271 of file iterator.h.

operator++() [1/2]

PcpPrimIterator & operator++ ( )

inline

Definition at line 249 of file iterator.h.

operator++() [2/2]

PcpPrimIterator operator++ ( int  )

inline

Definition at line 259 of file iterator.h.

operator+=()

PcpPrimIterator & operator+= ( const difference_type  increment )

inline

Definition at line 283 of file iterator.h.

operator-() [1/2]

PcpPrimIterator operator- ( const difference_type  decrement ) const

inline

Definition at line 277 of file iterator.h.

operator-() [2/2]

difference_type operator- ( const PcpPrimIterator &  other ) const

inline

Definition at line 245 of file iterator.h.

operator--() [1/2]

PcpPrimIterator & operator-- ( )

inline

Definition at line 254 of file iterator.h.

operator--() [2/2]

PcpPrimIterator operator-- ( int  )

inline

Definition at line 265 of file iterator.h.

operator-=()

PcpPrimIterator & operator-= ( const difference_type  decrement )

inline

Definition at line 288 of file iterator.h.

operator->()

pointer operator-> ( ) const

inline

Definition at line 238 of file iterator.h.

operator<()

bool operator< ( const PcpPrimIterator &  other ) const

inline

Definition at line 301 of file iterator.h.

operator<=()

bool operator<= ( const PcpPrimIterator &  other ) const

inline

Definition at line 306 of file iterator.h.

operator==()

bool operator== ( const PcpPrimIterator &  other ) const

inline

Definition at line 293 of file iterator.h.

operator>()

bool operator> ( const PcpPrimIterator &  other ) const

inline

Definition at line 311 of file iterator.h.

operator>=()

bool operator>= ( const PcpPrimIterator &  other ) const

inline

Definition at line 316 of file iterator.h.

operator[]()

reference operator[] ( const difference_type  index ) const

inline

Definition at line 239 of file iterator.h.

---

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

• pxr/usd/pcp/iterator.h