HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Friends | List of all members
UsdNotice::ObjectsChanged::PathRange Class Reference

#include <notice.h>

Classes

class  iterator
 

Public Types

using const_iterator = iterator
 

Public Member Functions

 PathRange ()
 
 operator SdfPathVector () const
 Explicit conversion to SdfPathVector for convenience. More...
 
bool empty () const
 Return true if this range contains any paths, false otherwise. More...
 
size_t size () const
 Return the number of paths in this range. More...
 
iterator begin () const
 Return iterator to the start of this range. More...
 
const_iterator cbegin () const
 Return iterator to the start of this range. More...
 
iterator end () const
 Return the end iterator for this range. More...
 
const_iterator cend () const
 Return the end iterator for this range. More...
 
const_iterator find (const SdfPath &path) const
 

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

using UsdNotice::ObjectsChanged::PathRange::const_iterator = iterator

Definition at line 255 of file notice.h.

Constructor & Destructor Documentation

UsdNotice::ObjectsChanged::PathRange::PathRange ( )
inline

Definition at line 257 of file notice.h.

Member Function Documentation

iterator UsdNotice::ObjectsChanged::PathRange::begin ( void  ) const
inline

Return iterator to the start of this range.

Definition at line 275 of file notice.h.

const_iterator UsdNotice::ObjectsChanged::PathRange::cbegin ( ) const
inline

Return iterator to the start of this range.

Definition at line 280 of file notice.h.

const_iterator UsdNotice::ObjectsChanged::PathRange::cend ( ) const
inline

Return the end iterator for this range.

Definition at line 290 of file notice.h.

bool UsdNotice::ObjectsChanged::PathRange::empty ( void  ) const
inline

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

Definition at line 265 of file notice.h.

iterator UsdNotice::ObjectsChanged::PathRange::end ( void  ) const
inline

Return the end iterator for this range.

Definition at line 285 of file notice.h.

const_iterator UsdNotice::ObjectsChanged::PathRange::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.

UsdNotice::ObjectsChanged::PathRange::operator SdfPathVector ( ) const
inlineexplicit

Explicit conversion to SdfPathVector for convenience.

Definition at line 260 of file notice.h.

size_t UsdNotice::ObjectsChanged::PathRange::size ( void  ) const
inline

Return the number of paths in this range.

Definition at line 270 of file notice.h.

Friends And Related Function Documentation

friend class ObjectsChanged
friend

Definition at line 302 of file notice.h.

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