NvRulesAPI: NV::Rules::IEvaluator Class Reference

# NV::Rules::IEvaluator Class Reference
[NvRules Tool lifetime-managed classes.]

Evaluator interface. More...

Inherits NV::Rules::IBaseContext.

## Public Member Functions
virtual std::string | get_version ()=0
| Get version number of this interface.
virtual bool | handle_exception (const char *msg)=0
| Context exception handler.
virtual void | require_metric (const char *metric)=0
virtual void | require_rule (const char *rule)=0

## Detailed Description

The evaluator is used during rule setup to pass information about rule dependencies to the tool. For most cases, its Python wrapper functions can be used instead for convenience.

## Member Function Documentation

virtual std::string NV::Rules::IBaseContext::get_version | ( |  | ) | `[pure virtual, inherited]`

Returns the version number of this interface as a string of the form <year>.<major>.<minor> It matches the Nsight Compute version this interface originates from.

virtual bool NV::Rules::IBaseContext::handle_exception | ( | const char * | msg | ) | `[pure virtual, inherited]`

Should return true if a python exception should be set, false otherwise

virtual void NV::Rules::IEvaluator::require_metric | ( | const char * | metric | ) | `[pure virtual]`

Define that the specified `metric` must have been collected in order for the calling rule to be applied.

virtual void NV::Rules::IEvaluator::require_rule | ( | const char * | rule | ) | `[pure virtual]`

Define that the specified `rule` must be available and ready to be applied in order for the calling rule to be applied itself.