This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
UsdPrimSiblingRange Class Reference

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

#include <prim.h>

Public Types

typedef UsdPrimSiblingIterator iterator
 Iterator type.
 
typedef UsdPrimSiblingIterator 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

 UsdPrimSiblingRange (UsdPrimSiblingIterator begin, UsdPrimSiblingIterator 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 UsdPrimSiblingRange &other) const
 Equality compare.
 
reference front () const
 Return *begin(). This range must not be empty.
 
UsdPrimSiblingRangeadvance_begin (difference_type n)
 Advance this range's begin iterator.
 
UsdPrimSiblingRangeadvance_end (difference_type n)
 Advance this range's end iterator.
 
bool empty () const
 Return begin() == end().
 

Friends

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

Detailed Description

Forward iterator range of sibling UsdPrim s.

This range type contains a pair of UsdPrimSiblingIterator 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 2366 of file prim.h.

Member Typedef Documentation

◆ const_iterator

Const iterator type.

Definition at line 2371 of file prim.h.

◆ difference_type

typedef std::ptrdiff_t difference_type

Iterator difference type.

Definition at line 2373 of file prim.h.

◆ iterator

Iterator type.

Definition at line 2369 of file prim.h.

◆ reference

Iterator reference_type.

Definition at line 2377 of file prim.h.

◆ value_type

Iterator value_type.

Definition at line 2375 of file prim.h.

Constructor & Destructor Documentation

◆ UsdPrimSiblingRange()

Construct with a pair of iterators.

Definition at line 2382 of file prim.h.

Member Function Documentation

◆ advance_begin()

UsdPrimSiblingRange & advance_begin ( difference_type  n)
inline

Advance this range's begin iterator.

Definition at line 2413 of file prim.h.

◆ advance_end()

UsdPrimSiblingRange & advance_end ( difference_type  n)
inline

Advance this range's end iterator.

Definition at line 2419 of file prim.h.

◆ begin()

iterator begin ( ) const
inline

First iterator.

Definition at line 2387 of file prim.h.

◆ cbegin()

const_iterator cbegin ( ) const
inline

First iterator.

Definition at line 2390 of file prim.h.

◆ cend()

const_iterator cend ( ) const
inline

Past-the-end iterator.

Definition at line 2396 of file prim.h.

◆ empty()

bool empty ( ) const
inline

Return begin() == end().

Definition at line 2425 of file prim.h.

◆ end()

iterator end ( ) const
inline

Past-the-end iterator.

Definition at line 2393 of file prim.h.

◆ equal()

bool equal ( const UsdPrimSiblingRange other) const
inline

Equality compare.

Definition at line 2402 of file prim.h.

◆ front()

reference front ( ) const
inline

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

Definition at line 2407 of file prim.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Return !empty().

Definition at line 2399 of file prim.h.

Friends And Related Function Documentation

◆ operator!= [1/3]

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

Inequality comparison.

Definition at line 2463 of file prim.h.

◆ operator!= [2/3]

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

Inequality comparison.

Definition at line 2470 of file prim.h.

◆ operator!= [3/3]

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

Inequality comparison.

Definition at line 2456 of file prim.h.

◆ operator== [1/3]

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

Equality comparison.

Definition at line 2450 of file prim.h.

◆ operator== [2/3]

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

Equality comparison.

Definition at line 2436 of file prim.h.

◆ operator== [3/3]

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

Equality comparison.

Definition at line 2429 of file prim.h.


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