#include <prim.h>

Public Types
typedef UsdPrimSubtreeIterator	iterator
	Iterator type. More...

typedef UsdPrimSubtreeIterator	const_iterator
	Const iterator type. More...

typedef std::ptrdiff_t	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 ()=default

	UsdPrimSubtreeRange (UsdPrimSubtreeIterator begin, UsdPrimSubtreeIterator end)
	Construct with a pair of iterators. More...

iterator	begin () const
	First iterator. More...

const_iterator	cbegin () const
	First iterator. More...

iterator	end () const
	Past-the-end iterator. More...

const_iterator	cend () const
	Past-the-end iterator. More...

	operator bool () const
	Return !empty(). More...

bool	equal (const UsdPrimSubtreeRange &other) const
	Equality compare. More...

reference	front () const
	Return *begin(). This range must not be empty. More...

UsdPrimSubtreeRange &	advance_begin (difference_type n)
	Advance this range's begin iterator. More...

UsdPrimSubtreeRange &	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...

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

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

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

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

template<class ForwardRange >
bool	operator!= (const UsdPrimSubtreeRange &lhs, const ForwardRange &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 2640 of file prim.h.

Member Typedef Documentation

typedef UsdPrimSubtreeIterator UsdPrimSubtreeRange::const_iterator

Const iterator type.

Definition at line 2645 of file prim.h.

typedef std::ptrdiff_t UsdPrimSubtreeRange::difference_type

Iterator difference type.

Definition at line 2647 of file prim.h.

typedef UsdPrimSubtreeIterator UsdPrimSubtreeRange::iterator

Iterator type.

Definition at line 2643 of file prim.h.

typedef iterator::reference UsdPrimSubtreeRange::reference

Iterator reference_type.

Definition at line 2651 of file prim.h.

typedef iterator::value_type UsdPrimSubtreeRange::value_type

Iterator value_type.

Definition at line 2649 of file prim.h.

Constructor & Destructor Documentation

UsdPrimSubtreeRange::UsdPrimSubtreeRange ( )

default

UsdPrimSubtreeRange::UsdPrimSubtreeRange	(	UsdPrimSubtreeIterator	begin,
		UsdPrimSubtreeIterator	end
	)

inline

Construct with a pair of iterators.

Definition at line 2656 of file prim.h.

Member Function Documentation

UsdPrimSubtreeRange& UsdPrimSubtreeRange::advance_begin ( difference_type n )

inline

Advance this range's begin iterator.

Definition at line 2689 of file prim.h.

UsdPrimSubtreeRange& UsdPrimSubtreeRange::advance_end ( difference_type n )

inline

Advance this range's end iterator.

Definition at line 2695 of file prim.h.

iterator UsdPrimSubtreeRange::begin ( void ) const

inline

First iterator.

Definition at line 2661 of file prim.h.

const_iterator UsdPrimSubtreeRange::cbegin ( ) const

inline

First iterator.

Definition at line 2664 of file prim.h.

const_iterator UsdPrimSubtreeRange::cend ( ) const

inline

Past-the-end iterator.

Definition at line 2670 of file prim.h.

bool UsdPrimSubtreeRange::empty ( void ) const

inline

Return begin() == end().

Definition at line 2701 of file prim.h.

iterator UsdPrimSubtreeRange::end ( void ) const

inline

Past-the-end iterator.

Definition at line 2667 of file prim.h.

bool UsdPrimSubtreeRange::equal ( const UsdPrimSubtreeRange & other ) const

inline

Equality compare.

Definition at line 2678 of file prim.h.

reference UsdPrimSubtreeRange::front ( void ) const

inline

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

Definition at line 2683 of file prim.h.

UsdPrimSubtreeRange::operator bool ( ) const

inlineexplicit

Return !empty().

Definition at line 2673 of file prim.h.

Friends And Related Function Documentation

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

friend

Inequality comparison.

Definition at line 2733 of file prim.h.

template<class ForwardRange >

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

friend

Inequality comparison.

Definition at line 2740 of file prim.h.

template<class ForwardRange >

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

friend

Inequality comparison.

Definition at line 2747 of file prim.h.

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

friend

Equality comparison.

Definition at line 2705 of file prim.h.

template<class ForwardRange >

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

friend

Equality comparison.

Definition at line 2712 of file prim.h.

template<class ForwardRange >

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

friend

Equality comparison.

Definition at line 2727 of file prim.h.

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

pxr/usd/usd/prim.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation