PcpPropertyIterator Class Reference

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

#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.
PCP_API	PcpPropertyIterator (const PcpPropertyIndex &index, size_t pos=0)
	Constructs a property iterator for index beginning at position pos in the property stack.
PCP_API PcpNodeRef	GetNode () const
	Returns the PcpNode from which the current property originated.
PCP_API bool	IsLocal () const
	Returns true if the current property is local to the owning property index's layer stack, false otherwise.
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 362 of file iterator.h.

Member Typedef Documentation

difference_type

using difference_type = std::ptrdiff_t

Definition at line 369 of file iterator.h.

iterator_category

using iterator_category = std::random_access_iterator_tag

Definition at line 365 of file iterator.h.

pointer

using pointer = const SdfPropertySpecHandle*

Definition at line 368 of file iterator.h.

reference

using reference = const SdfPropertySpecHandle&

Definition at line 367 of file iterator.h.

value_type

using value_type = const SdfPropertySpecHandle

Definition at line 366 of file iterator.h.

Constructor & Destructor Documentation

PcpPropertyIterator() [1/2]

PCP_API PcpPropertyIterator

(

)

Constructs an invalid iterator.

PcpPropertyIterator() [2/2]

PCP_API 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

GetNode()

PCP_API PcpNodeRef GetNode

(

)

const

Returns the PcpNode from which the current property originated.

IsLocal()

PCP_API bool IsLocal

(

)

const

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

operator!=()

bool operator!= ( const PcpPropertyIterator &  other ) const

inline

Definition at line 449 of file iterator.h.

operator*()

reference operator* ( ) const

inline

Definition at line 389 of file iterator.h.

operator+()

PcpPropertyIterator operator+ ( const difference_type  increment ) const

inline

Definition at line 423 of file iterator.h.

operator++() [1/2]

PcpPropertyIterator & operator++ ( )

inline

Definition at line 401 of file iterator.h.

operator++() [2/2]

PcpPropertyIterator operator++ ( int  )

inline

Definition at line 411 of file iterator.h.

operator+=()

PcpPropertyIterator & operator+= ( const difference_type  increment )

inline

Definition at line 435 of file iterator.h.

operator-() [1/2]

PcpPropertyIterator operator- ( const difference_type  decrement ) const

inline

Definition at line 429 of file iterator.h.

operator-() [2/2]

difference_type operator- ( const PcpPropertyIterator &  other ) const

inline

Definition at line 397 of file iterator.h.

operator--() [1/2]

PcpPropertyIterator & operator-- ( )

inline

Definition at line 406 of file iterator.h.

operator--() [2/2]

PcpPropertyIterator operator-- ( int  )

inline

Definition at line 417 of file iterator.h.

operator-=()

PcpPropertyIterator & operator-= ( const difference_type  decrement )

inline

Definition at line 440 of file iterator.h.

operator->()

pointer operator-> ( ) const

inline

Definition at line 390 of file iterator.h.

operator<()

bool operator< ( const PcpPropertyIterator &  other ) const

inline

Definition at line 453 of file iterator.h.

operator<=()

bool operator<= ( const PcpPropertyIterator &  other ) const

inline

Definition at line 458 of file iterator.h.

operator==()

bool operator== ( const PcpPropertyIterator &  other ) const

inline

Definition at line 445 of file iterator.h.

operator>()

bool operator> ( const PcpPropertyIterator &  other ) const

inline

Definition at line 463 of file iterator.h.

operator>=()

bool operator>= ( const PcpPropertyIterator &  other ) const

inline

Definition at line 468 of file iterator.h.

operator[]()

reference operator[] ( const difference_type  index ) const

inline

Definition at line 391 of file iterator.h.

---

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

• pxr/usd/pcp/iterator.h