All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SdfPathAncestorsRange Class Reference

Range representing a path and ancestors, and providing methods for iterating over them. More...

#include <path.h>

Public Member Functions

 SdfPathAncestorsRange (const SdfPath &path)
 
const SdfPathGetPath () const
 
iterator begin () const
 
iterator end () const
 

Detailed Description

Range representing a path and ancestors, and providing methods for iterating over them.

An ancestor range represents a path and all of its ancestors ordered from nearest to furthest (root-most). For example, given a path like /a/b.prop, the range represents paths /a/b.prop, /a/b and /a, in that order. A range accepts relative paths as well: For path a/b.prop, the range represents paths 'a/b.prop,a/banda. If a path contains parent path elements, (..), those elements are treated as elements of the range. For instance, given path../a/b, the range represents paths../a/b,../aand... This represents the same of set ofprefix` paths as SdfPath::GetPrefixes, but in reverse order.

Definition at line 1076 of file path.h.

Constructor & Destructor Documentation

◆ SdfPathAncestorsRange()

SdfPathAncestorsRange ( const SdfPath path)
inline

Definition at line 1080 of file path.h.

Member Function Documentation

◆ begin()

iterator begin ( ) const
inline

Definition at line 1117 of file path.h.

◆ end()

iterator end ( ) const
inline

Definition at line 1119 of file path.h.

◆ GetPath()

const SdfPath & GetPath ( ) const
inline

Definition at line 1083 of file path.h.


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