All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdPrimSubtreeRange Class Reference

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

Public Types

typedef UsdPrimSubtreeIterator iterator
 Iterator type. More...
 
typedef UsdPrimSubtreeIterator const_iterator
 Const iterator type. More...
 
typedef unspecified integral type difference_type
 Iterator difference type. More...
 
typedef iterator::value_type value_type
 Iterator value_type. More...
 
typedef iterator::reference reference
 Iterator reference_type. More...
 

Public Member Functions

 UsdPrimSubtreeRange (UsdPrimSubtreeIterator begin, UsdPrimSubtreeIterator end)
 Construct with a pair of iterators. More...
 
template<class ForwardRange >
 UsdPrimSubtreeRange (const ForwardRange &r)
 Construct/convert from another compatible range type. More...
 
template<class ForwardRange >
UsdPrimSubtreeRangeoperator= (const ForwardRange &r)
 Assign from another compatible range type. More...
 
iterator begin () const
 First iterator. More...
 
iterator end () const
 Past-the-end iterator. More...
 
 operator unspecified_bool_type () const
 Return !empty(). More...
 
bool equal (const iterator_range &) const
 Equality compare. More...
 
reference front () const
 Return *begin(). This range must not be empty. More...
 
iterator_range & advance_begin (difference_type n)
 Advance this range's begin iterator. More...
 
iterator_range & advance_end (difference_type n)
 Advance this range's end iterator. More...
 
bool empty () const
 Return begin() == end(). More...
 

Friends

bool operator== (const UsdPrimSubtreeRange &lhs, const UsdPrimSubtreeRange &rhs)
 Equality comparison. More...
 
bool operator!= (const UsdPrimSubtreeRange &lhs, const UsdPrimSubtreeRange &rhs)
 Inequality comparison. More...
 

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 1893 of file prim.h.

Member Typedef Documentation

Const iterator type.

Definition at line 1898 of file prim.h.

typedef unspecified integral type difference_type

Iterator difference type.

Definition at line 1900 of file prim.h.

Iterator type.

Definition at line 1896 of file prim.h.

Iterator reference_type.

Definition at line 1904 of file prim.h.

Iterator value_type.

Definition at line 1902 of file prim.h.

Constructor & Destructor Documentation

Construct with a pair of iterators.

UsdPrimSubtreeRange ( const ForwardRange &  r)

Construct/convert from another compatible range type.

Member Function Documentation

iterator_range& advance_begin ( difference_type  n)

Advance this range's begin iterator.

iterator_range& advance_end ( difference_type  n)

Advance this range's end iterator.

iterator begin ( ) const

First iterator.

bool empty ( ) const

Return begin() == end().

iterator end ( ) const

Past-the-end iterator.

bool equal ( const iterator_range &  ) const

Equality compare.

reference front ( ) const

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

operator unspecified_bool_type ( ) const

Return !empty().

UsdPrimSubtreeRange& operator= ( const ForwardRange &  r)

Assign from another compatible range type.

Friends And Related Function Documentation

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

Inequality comparison.

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

Equality comparison.


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