SdfPathExpressionEval< DomainType > Class Template Reference

Objects of this class evaluate complete SdfPathExpressions. More...

#include <pathExpressionEval.h>

Inherits Sdf_PathExpressionEvalBase.

Classes
class	IncrementalSearcher
	This class implements stateful incremental search over DomainType objects in depth-first order. More...

Public Member Functions
bool	IsEmpty () const
template<class PathToObject >
SdfPredicateFunctionResult	Match (SdfPath const &objPath, PathToObject const &pathToObj) const
	Test objPath for a match with this expression.
template<class PathToObject >
IncrementalSearcher< std::decay_t< PathToObject > >	MakeIncrementalSearcher (PathToObject &&pathToObj) const
	Create an IncrementalSearcher object, using pathToObject to map DomainType instances to their paths.

Friends
SdfPathExpressionEval	SdfMakePathExpressionEval (SdfPathExpression const &expr, SdfPredicateLibrary< DomainType > const &lib)
	Make an SdfPathExpressionEval object to evaluate expr using lib to link any embedded predicate expressions.

Detailed Description

template<class DomainType>
class SdfPathExpressionEval< DomainType >

Objects of this class evaluate complete SdfPathExpressions.

See SdfMakePathExpressionEval() to create instances of this class, passing the expression to evaluate and an SdfPredicateLibrary to evaluate any embedded predicates.

Definition at line 181 of file pathExpressionEval.h.

Member Function Documentation

IsEmpty()

bool IsEmpty ( ) const

inline

Definition at line 236 of file pathExpressionEval.h.

MakeIncrementalSearcher()

IncrementalSearcher< std::decay_t< PathToObject > > MakeIncrementalSearcher ( PathToObject &&  pathToObj ) const

inline

Create an IncrementalSearcher object, using pathToObject to map DomainType instances to their paths.

Definition at line 330 of file pathExpressionEval.h.

Match()

SdfPredicateFunctionResult Match ( SdfPath const &  objPath, PathToObject const &  pathToObj  ) const

inline

Test objPath for a match with this expression.

Definition at line 243 of file pathExpressionEval.h.

Friends And Related Function Documentation

SdfMakePathExpressionEval

SdfPathExpressionEval SdfMakePathExpressionEval ( SdfPathExpression const &  expr, SdfPredicateLibrary< DomainType > const &  lib  )

friend

Make an SdfPathExpressionEval object to evaluate expr using lib to link any embedded predicate expressions.

Note that expr must be "complete", meaning that SdfPathExpression::IsComplete() must return true. If an evaluator cannot succesfully be made, possibly because the passed \expr is not complete, or if any embedded SdfPredicateExpression s cannot be successfully linked with lib, or another reason, issue an error and return the empty SdfPathExpressionEval object. See SdfPathExpressionEval::IsEmpty().

Definition at line 352 of file pathExpressionEval.h.

---

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

• pxr/usd/sdf/pathExpressionEval.h