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

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

typedef UsdPrimSiblingIterator	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
	UsdPrimSiblingRange (UsdPrimSiblingIterator begin, UsdPrimSiblingIterator end)
	Construct with a pair of iterators. More...

template<class ForwardRange >
	UsdPrimSiblingRange (const ForwardRange &r)
	Construct/convert from another compatible range type. More...

template<class ForwardRange >
UsdPrimSiblingRange &	operator= (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 UsdPrimSiblingRange &lhs, const UsdPrimSiblingRange &rhs)
	Equality comparison. More...

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

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

Member Typedef Documentation

◆ const_iterator

typedef UsdPrimSiblingIterator const_iterator

Const iterator type.

Definition at line 2253 of file prim.h.

◆ difference_type

typedef unspecified integral type difference_type

Iterator difference type.

Definition at line 2255 of file prim.h.

◆ iterator

typedef UsdPrimSiblingIterator iterator

Iterator type.

Definition at line 2251 of file prim.h.

◆ reference

typedef iterator::reference reference

Iterator reference_type.

Definition at line 2259 of file prim.h.

◆ value_type

typedef iterator::value_type value_type

Iterator value_type.

Definition at line 2257 of file prim.h.

Constructor & Destructor Documentation

◆ UsdPrimSiblingRange() [1/2]

UsdPrimSiblingRange	(	UsdPrimSiblingIterator	begin,
		UsdPrimSiblingIterator	end
	)

Construct with a pair of iterators.

◆ UsdPrimSiblingRange() [2/2]

UsdPrimSiblingRange ( const ForwardRange & r )

Construct/convert from another compatible range type.

Member Function Documentation

◆ advance_begin()

iterator_range& advance_begin ( difference_type n )

Advance this range's begin iterator.

◆ advance_end()

iterator_range& advance_end ( difference_type n )

Advance this range's end iterator.

◆ begin()

iterator begin ( ) const

First iterator.

◆ empty()

bool empty ( ) const

Return begin() == end().

◆ end()

iterator end ( ) const

Past-the-end iterator.

◆ equal()

bool equal ( const iterator_range & ) const

Equality compare.

◆ front()

reference front ( ) const

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

◆ operator unspecified_bool_type()

operator unspecified_bool_type ( ) const

Return !empty().

◆ operator=()

UsdPrimSiblingRange& operator= ( const ForwardRange & r )

Assign from another compatible range type.

Friends And Related Function Documentation

◆ operator!=

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

friend

Inequality comparison.

◆ operator==

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