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
SdfPredicateLibrary< DomainType > Class Template Reference

#include <predicateLibrary.h>

Public Types

using PredicateFunction = std::function< SdfPredicateFunctionResult(DomainType const &)>
 The type of a bound function, the result of binding passed arguments. More...
 

Public Member Functions

 SdfPredicateLibrary ()=default
 Default constructor produces an empty library. More...
 
 SdfPredicateLibrary (SdfPredicateLibrary &&other)=default
 Move-construct from an other library. More...
 
 SdfPredicateLibrary (SdfPredicateLibrary const &other)
 Copy-construct from an other library. More...
 
SdfPredicateLibrary & operator= (SdfPredicateLibrary &&other)=default
 Move-assignment from an other library. More...
 
SdfPredicateLibrary & operator= (SdfPredicateLibrary const &other)
 Copy-assignment from an other library. More...
 
template<class Fn >
SdfPredicateLibrary & Define (char const *name, Fn &&fn)
 
template<class Fn >
SdfPredicateLibrary & Define (std::string const &name, Fn &&fn, NamesAndDefaults const &namesAndDefaults)
 
template<class Fn >
SdfPredicateLibrary & DefineBinder (std::string const &name, Fn &&fn)
 

Friends

SdfPredicateProgram< DomainType > SdfLinkPredicateExpression (SdfPredicateExpression const &expr, SdfPredicateLibrary const &lib)
 

Detailed Description

template<class DomainType>
class SdfPredicateLibrary< DomainType >

Represents a library of predicate functions for use with SdfPredicateExpression. Call SdfLinkPredicateExpression() with an expression and a library to produce a callable SdfPredicateProgram.

Definition at line 218 of file predicateLibrary.h.

Member Typedef Documentation

template<class DomainType>
using SdfPredicateLibrary< DomainType >::PredicateFunction = std::function<SdfPredicateFunctionResult (DomainType const &)>

The type of a bound function, the result of binding passed arguments.

Definition at line 244 of file predicateLibrary.h.

Constructor & Destructor Documentation

template<class DomainType>
SdfPredicateLibrary< DomainType >::SdfPredicateLibrary ( )
default

Default constructor produces an empty library.

template<class DomainType>
SdfPredicateLibrary< DomainType >::SdfPredicateLibrary ( SdfPredicateLibrary< DomainType > &&  other)
default

Move-construct from an other library.

template<class DomainType>
SdfPredicateLibrary< DomainType >::SdfPredicateLibrary ( SdfPredicateLibrary< DomainType > const &  other)
inline

Copy-construct from an other library.

Definition at line 253 of file predicateLibrary.h.

Member Function Documentation

template<class DomainType>
template<class Fn >
SdfPredicateLibrary& SdfPredicateLibrary< DomainType >::Define ( char const *  name,
Fn &&  fn 
)
inline

Register a function with name name in this library. The first argument must accept a DomainType instance. The remaining arguments must be convertible from bool, int, float, string.

Definition at line 279 of file predicateLibrary.h.

template<class DomainType>
template<class Fn >
SdfPredicateLibrary& SdfPredicateLibrary< DomainType >::Define ( std::string const &  name,
Fn &&  fn,
NamesAndDefaults const &  namesAndDefaults 
)
inline

Register a function with name name in this library. The first argument must accept a DomainType instance. The remaining arguments must be convertible from bool, int, float, string. Optional parameter names and default values may be supplied in namesAndDefaults.

Definition at line 289 of file predicateLibrary.h.

template<class DomainType>
template<class Fn >
SdfPredicateLibrary& SdfPredicateLibrary< DomainType >::DefineBinder ( std::string const &  name,
Fn &&  fn 
)
inline

Register a custom binding function for name in this library. The function must take a single argument of type std::vector<SdfPredicateExpression::FnArg>. When invoked, it must attempt to bind the arguments passed in the vector and return a bound PredicateFunction object. If the arguments are invalid, return an empty PredicateFunction.

Definition at line 311 of file predicateLibrary.h.

template<class DomainType>
SdfPredicateLibrary& SdfPredicateLibrary< DomainType >::operator= ( SdfPredicateLibrary< DomainType > &&  other)
default

Move-assignment from an other library.

template<class DomainType>
SdfPredicateLibrary& SdfPredicateLibrary< DomainType >::operator= ( SdfPredicateLibrary< DomainType > const &  other)
inline

Copy-assignment from an other library.

Definition at line 267 of file predicateLibrary.h.

Friends And Related Function Documentation

template<class DomainType>
SdfPredicateProgram<DomainType> SdfLinkPredicateExpression ( SdfPredicateExpression const &  expr,
SdfPredicateLibrary< DomainType > const &  lib 
)
friend

Link expr with lib and return a callable program that evaluates expr on given objects of the DomainType. If linking expr and lib fails, issue a TF_RUNTIME_ERROR with a message, and return an empty program.

Definition at line 165 of file predicateProgram.h.

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