UsdNotice::ObjectsChanged::PathRange Class Reference

An iterable range of paths to objects that have changed. More...

#include <notice.h>

Public Types
using	const_iterator = iterator

Public Member Functions
	operator SdfPathVector () const
	Explicit conversion to SdfPathVector for convenience.
bool	empty () const
	Return true if this range contains any paths, false otherwise.
size_t	size () const
	Return the number of paths in this range.
iterator	begin () const
	Return iterator to the start of this range.
const_iterator	cbegin () const
	Return iterator to the start of this range.
iterator	end () const
	Return the end iterator for this range.
const_iterator	cend () const
	Return the end iterator for this range.
const_iterator	find (const SdfPath &path) const
	Return an iterator to the specified path in this range if it exists, or end() if it does not.

Friends
class	ObjectsChanged

Detailed Description

An iterable range of paths to objects that have changed.

Users may use this object in range-based for loops, or use the iterators to access additional information about each changed object.

Definition at line 183 of file notice.h.

Member Typedef Documentation

const_iterator

using const_iterator = iterator

Definition at line 255 of file notice.h.

Constructor & Destructor Documentation

PathRange()

PathRange ( )

inline

Definition at line 257 of file notice.h.

Member Function Documentation

begin()

iterator begin ( ) const

inline

Return iterator to the start of this range.

Definition at line 275 of file notice.h.

cbegin()

const_iterator cbegin ( ) const

inline

Return iterator to the start of this range.

Definition at line 280 of file notice.h.

cend()

const_iterator cend ( ) const

inline

Return the end iterator for this range.

Definition at line 290 of file notice.h.

empty()

bool empty ( ) const

inline

Return true if this range contains any paths, false otherwise.

Definition at line 265 of file notice.h.

end()

iterator end ( ) const

inline

Return the end iterator for this range.

Definition at line 285 of file notice.h.

find()

const_iterator find ( const SdfPath &  path ) const

inline

Return an iterator to the specified path in this range if it exists, or end() if it does not.

This is potentially more efficient than std::find(begin(), end()).

Definition at line 297 of file notice.h.

operator SdfPathVector()

operator SdfPathVector ( ) const

inlineexplicit

Explicit conversion to SdfPathVector for convenience.

Definition at line 260 of file notice.h.

size()

size_t size ( ) const

inline

Return the number of paths in this range.

Definition at line 270 of file notice.h.

Friends And Related Function Documentation

ObjectsChanged

friend class ObjectsChanged

friend

Definition at line 302 of file notice.h.

---

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

• pxr/usd/usd/notice.h