PcpPropertyIterator Class Reference

#include <iterator.h>

Public Types
using	iterator_category = std::random_access_iterator_tag
using	value_type = const SdfPropertySpecHandle
using	reference = const SdfPropertySpecHandle &
using	pointer = const SdfPropertySpecHandle *
using	difference_type = std::ptrdiff_t

Public Member Functions
PCP_API	PcpPropertyIterator ()
	Constructs an invalid iterator. More...
PCP_API	PcpPropertyIterator (const PcpPropertyIndex &index, size_t pos=0)
PCP_API PcpNodeRef	GetNode () const
	Returns the PcpNode from which the current property originated. More...
PCP_API bool	IsLocal () const
reference	operator* () const
pointer	operator-> () const
reference	operator[] (const difference_type index) const
difference_type	operator- (const PcpPropertyIterator &other) const
PcpPropertyIterator &	operator++ ()
PcpPropertyIterator &	operator-- ()
PcpPropertyIterator	operator++ (int)
PcpPropertyIterator	operator-- (int)
PcpPropertyIterator	operator+ (const difference_type increment) const
PcpPropertyIterator	operator- (const difference_type decrement) const
PcpPropertyIterator &	operator+= (const difference_type increment)
PcpPropertyIterator &	operator-= (const difference_type decrement)
bool	operator== (const PcpPropertyIterator &other) const
bool	operator!= (const PcpPropertyIterator &other) const
bool	operator< (const PcpPropertyIterator &other) const
bool	operator<= (const PcpPropertyIterator &other) const
bool	operator> (const PcpPropertyIterator &other) const
bool	operator>= (const PcpPropertyIterator &other) const

Detailed Description

Object used to iterate over property specs in a property index in strong-to-weak order.

Definition at line 371 of file iterator.h.

Member Typedef Documentation

using PcpPropertyIterator::difference_type = std::ptrdiff_t

Definition at line 378 of file iterator.h.

using PcpPropertyIterator::iterator_category = std::random_access_iterator_tag

Definition at line 374 of file iterator.h.

using PcpPropertyIterator::pointer = const SdfPropertySpecHandle*

Definition at line 377 of file iterator.h.

using PcpPropertyIterator::reference = const SdfPropertySpecHandle&

Definition at line 376 of file iterator.h.

using PcpPropertyIterator::value_type = const SdfPropertySpecHandle

Definition at line 375 of file iterator.h.

Constructor & Destructor Documentation

PCP_API PcpPropertyIterator::PcpPropertyIterator

(

)

Constructs an invalid iterator.

PCP_API PcpPropertyIterator::PcpPropertyIterator	(	const PcpPropertyIndex &	index,
		size_t	pos = 0
	)

Constructs a property iterator for index beginning at position pos in the property stack.

Member Function Documentation

PCP_API PcpNodeRef PcpPropertyIterator::GetNode

(

)

const

Returns the PcpNode from which the current property originated.

PCP_API bool PcpPropertyIterator::IsLocal

(

)

const

Returns true if the current property is local to the owning property index's layer stack, false otherwise.

bool PcpPropertyIterator::operator!= ( const PcpPropertyIterator &  other ) const

inline

Definition at line 458 of file iterator.h.

reference PcpPropertyIterator::operator* ( ) const

inline

Definition at line 398 of file iterator.h.

PcpPropertyIterator PcpPropertyIterator::operator+ ( const difference_type  increment ) const

inline

Definition at line 432 of file iterator.h.

PcpPropertyIterator& PcpPropertyIterator::operator++ ( )

inline

Definition at line 410 of file iterator.h.

PcpPropertyIterator PcpPropertyIterator::operator++ ( int  )

inline

Definition at line 420 of file iterator.h.

PcpPropertyIterator& PcpPropertyIterator::operator+= ( const difference_type  increment )

inline

Definition at line 444 of file iterator.h.

difference_type PcpPropertyIterator::operator- ( const PcpPropertyIterator &  other ) const

inline

Definition at line 406 of file iterator.h.

PcpPropertyIterator PcpPropertyIterator::operator- ( const difference_type  decrement ) const

inline

Definition at line 438 of file iterator.h.

PcpPropertyIterator& PcpPropertyIterator::operator-- ( )

inline

Definition at line 415 of file iterator.h.

PcpPropertyIterator PcpPropertyIterator::operator-- ( int  )

inline

Definition at line 426 of file iterator.h.

PcpPropertyIterator& PcpPropertyIterator::operator-= ( const difference_type  decrement )

inline

Definition at line 449 of file iterator.h.

pointer PcpPropertyIterator::operator-> ( ) const

inline

Definition at line 399 of file iterator.h.

bool PcpPropertyIterator::operator< ( const PcpPropertyIterator &  other ) const

inline

Definition at line 462 of file iterator.h.

bool PcpPropertyIterator::operator<= ( const PcpPropertyIterator &  other ) const

inline

Definition at line 467 of file iterator.h.

bool PcpPropertyIterator::operator== ( const PcpPropertyIterator &  other ) const

inline

Definition at line 454 of file iterator.h.

bool PcpPropertyIterator::operator> ( const PcpPropertyIterator &  other ) const

inline

Definition at line 472 of file iterator.h.

bool PcpPropertyIterator::operator>= ( const PcpPropertyIterator &  other ) const

inline

Definition at line 477 of file iterator.h.

reference PcpPropertyIterator::operator[] ( const difference_type  index ) const

inline

Definition at line 400 of file iterator.h.

---

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

• pxr/usd/pcp/iterator.h