UsdPrimSiblingIterator Class Reference

Forward traversal iterator of sibling UsdPrim s. More...

#include <prim.h>

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = UsdPrim
using	reference = UsdPrim
using	pointer = _PtrProxy
using	difference_type = std::ptrdiff_t

Public Member Functions
reference	operator* () const
	Dereference.
pointer	operator-> () const
	Indirection.
UsdPrimSiblingIterator &	operator++ ()
	Preincrement.
UsdPrimSiblingIterator	operator++ (int)
	Postincrement.
bool	operator== (const UsdPrimSiblingIterator &other) const
bool	operator!= (const UsdPrimSiblingIterator &other) const

Friends
class	UsdPrim

Detailed Description

Forward traversal iterator of sibling UsdPrim s.

This is a standard-compliant iterator that may be used with STL algorithms, etc. Filters according to a supplied predicate.

Definition at line 2275 of file prim.h.

Member Typedef Documentation

difference_type

using difference_type = std::ptrdiff_t

Definition at line 2290 of file prim.h.

iterator_category

using iterator_category = std::forward_iterator_tag

Definition at line 2286 of file prim.h.

pointer

using pointer = _PtrProxy

Definition at line 2289 of file prim.h.

reference

using reference = UsdPrim

Definition at line 2288 of file prim.h.

value_type

using value_type = UsdPrim

Definition at line 2287 of file prim.h.

Member Function Documentation

operator!=()

bool operator!= ( const UsdPrimSiblingIterator &  other ) const

inline

Definition at line 2318 of file prim.h.

operator*()

reference operator* ( ) const

inline

Dereference.

Definition at line 2296 of file prim.h.

operator++() [1/2]

UsdPrimSiblingIterator & operator++ ( )

inline

Preincrement.

Definition at line 2302 of file prim.h.

operator++() [2/2]

UsdPrimSiblingIterator operator++ ( int  )

inline

Postincrement.

Definition at line 2308 of file prim.h.

operator->()

pointer operator-> ( ) const

inline

Indirection.

Definition at line 2299 of file prim.h.

operator==()

bool operator== ( const UsdPrimSiblingIterator &  other ) const

inline

Definition at line 2314 of file prim.h.

Friends And Related Function Documentation

UsdPrim

friend class UsdPrim

friend

Definition at line 2323 of file prim.h.

---

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

• pxr/usd/usd/prim.h