Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
UsdPrimSubtreeRange Class Reference

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

#include <prim.h>

Public Types

typedef UsdPrimSubtreeIterator iterator
 Iterator type.
 
typedef UsdPrimSubtreeIterator const_iterator
 Const iterator type.
 
typedef std::ptrdiff_t difference_type
 Iterator difference type.
 
typedef iterator::value_type value_type
 Iterator value_type.
 
typedef iterator::reference reference
 Iterator reference_type.
 

Public Member Functions

 UsdPrimSubtreeRange (UsdPrimSubtreeIterator begin, UsdPrimSubtreeIterator end)
 Construct with a pair of iterators.
 
iterator begin () const
 First iterator.
 
const_iterator cbegin () const
 First iterator.
 
iterator end () const
 Past-the-end iterator.
 
const_iterator cend () const
 Past-the-end iterator.
 
 operator bool () const
 Return !empty().
 
bool equal (const UsdPrimSubtreeRange &other) const
 Equality compare.
 
reference front () const
 Return *begin(). This range must not be empty.
 
UsdPrimSubtreeRange & advance_begin (difference_type n)
 Advance this range's begin iterator.
 
UsdPrimSubtreeRange & advance_end (difference_type n)
 Advance this range's end iterator.
 
bool empty () const
 Return begin() == end().
 

Friends

bool operator== (const UsdPrimSubtreeRange &lhs, const UsdPrimSubtreeRange &rhs)
 Equality comparison.
 
template<class ForwardRange >
bool operator== (const UsdPrimSubtreeRange &lhs, const ForwardRange &rhs)
 Equality comparison.
 
template<class ForwardRange >
bool operator== (const ForwardRange &lhs, const UsdPrimSubtreeRange &rhs)
 Equality comparison.
 
bool operator!= (const UsdPrimSubtreeRange &lhs, const UsdPrimSubtreeRange &rhs)
 Inequality comparison.
 
template<class ForwardRange >
bool operator!= (const ForwardRange &lhs, const UsdPrimSubtreeRange &rhs)
 Inequality comparison.
 
template<class ForwardRange >
bool operator!= (const UsdPrimSubtreeRange &lhs, const ForwardRange &rhs)
 Inequality comparison.
 

Detailed Description

Forward iterator range of sibling UsdPrim s.

This range type contains a pair of UsdPrimSubtreeIterator s, denoting a half-open range of UsdPrim siblings. It provides a subset of container-like API, such as begin(), end(), front(), empty(), etc.

Definition at line 2629 of file prim.h.

Member Typedef Documentation

◆ const_iterator

typedef UsdPrimSubtreeIterator const_iterator

Const iterator type.

Definition at line 2634 of file prim.h.

◆ difference_type

typedef std::ptrdiff_t difference_type

Iterator difference type.

Definition at line 2636 of file prim.h.

◆ iterator

typedef UsdPrimSubtreeIterator iterator

Iterator type.

Definition at line 2632 of file prim.h.

◆ reference

typedef iterator::reference reference

Iterator reference_type.

Definition at line 2640 of file prim.h.

◆ value_type

typedef iterator::value_type value_type

Iterator value_type.

Definition at line 2638 of file prim.h.

Constructor & Destructor Documentation

◆ UsdPrimSubtreeRange()

UsdPrimSubtreeRange ( UsdPrimSubtreeIterator  begin,
UsdPrimSubtreeIterator  end 
)
inline

Construct with a pair of iterators.

Definition at line 2645 of file prim.h.

Member Function Documentation

◆ advance_begin()

UsdPrimSubtreeRange & advance_begin ( difference_type  n)
inline

Advance this range's begin iterator.

Definition at line 2678 of file prim.h.

◆ advance_end()

UsdPrimSubtreeRange & advance_end ( difference_type  n)
inline

Advance this range's end iterator.

Definition at line 2684 of file prim.h.

◆ begin()

iterator begin ( ) const
inline

First iterator.

Definition at line 2650 of file prim.h.

◆ cbegin()

const_iterator cbegin ( ) const
inline

First iterator.

Definition at line 2653 of file prim.h.

◆ cend()

const_iterator cend ( ) const
inline

Past-the-end iterator.

Definition at line 2659 of file prim.h.

◆ empty()

bool empty ( ) const
inline

Return begin() == end().

Definition at line 2690 of file prim.h.

◆ end()

iterator end ( ) const
inline

Past-the-end iterator.

Definition at line 2656 of file prim.h.

◆ equal()

bool equal ( const UsdPrimSubtreeRange &  other) const
inline

Equality compare.

Definition at line 2667 of file prim.h.

◆ front()

reference front ( ) const
inline

Return *begin(). This range must not be empty.

Definition at line 2672 of file prim.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Return !empty().

Definition at line 2662 of file prim.h.

Friends And Related Function Documentation

◆ operator!= [1/3]

bool operator!= ( const ForwardRange &  lhs,
const UsdPrimSubtreeRange &  rhs 
)
friend

Inequality comparison.

Definition at line 2729 of file prim.h.

◆ operator!= [2/3]

bool operator!= ( const UsdPrimSubtreeRange &  lhs,
const ForwardRange &  rhs 
)
friend

Inequality comparison.

Definition at line 2736 of file prim.h.

◆ operator!= [3/3]

bool operator!= ( const UsdPrimSubtreeRange &  lhs,
const UsdPrimSubtreeRange &  rhs 
)
friend

Inequality comparison.

Definition at line 2722 of file prim.h.

◆ operator== [1/3]

bool operator== ( const ForwardRange &  lhs,
const UsdPrimSubtreeRange &  rhs 
)
friend

Equality comparison.

Definition at line 2716 of file prim.h.

◆ operator== [2/3]

bool operator== ( const UsdPrimSubtreeRange &  lhs,
const ForwardRange &  rhs 
)
friend

Equality comparison.

Definition at line 2701 of file prim.h.

◆ operator== [3/3]

bool operator== ( const UsdPrimSubtreeRange &  lhs,
const UsdPrimSubtreeRange &  rhs 
)
friend

Equality comparison.

Definition at line 2694 of file prim.h.

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