NV::Rules — NsightCompute 12.6 documentation

# NV::Rules

namespace Rules

Data Structures

IAction

  Action interface.

IBaseContext

IContext

  Context interface.

IController

  Controller interface.

IEvaluator

  Evaluator interface.

IFrontend

  Frontend interface.

IMessageVault

IMetric

  Metric interface.

INvtxDomainInfo

  NvtxDomainInfo interface.

INvtxRange

  NvtxRange interface.

INvtxState

  NvtxState interface.

IRange

  Range interface.

ISourceInfo

  SourceInfo interface.

Enumerations

RuleKind

  Rule kind.

Functions

IContext * get_context(ContextHandle h)

  Converts the context handle.

IEvaluator * get_evaluator(ContextHandle h)

  Returns the evaluator object.

std::string get_version(ContextHandle h)

  Get version number of this interface.

void raise_exception(ContextHandle h, const char *msg)

  Raises a python exception.

Typedefs

ContextHandle

## Enumerations

enum class NV::Rules::RuleKind

  Rule kind.

  Reserved for future use.

  Values:

  enumerator DEFAULT
  enumerator GUIDED

## Functions

IContext *NV::Rules::get_context(ContextHandle h)

  Converts the context handle.

  Converts the context handle `h` to an IContext object

IEvaluator *NV::Rules::get_evaluator(ContextHandle h)

  Returns the evaluator object.

  Return the IEvaluator object from the context handle `h`

std::string NV::Rules::get_version(ContextHandle h)

  Get version number of this interface.

  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.

void NV::Rules::raise_exception(ContextHandle h, const char *msg)

  Raises a python exception.

  Raise a python exception with `msg`. This will terminate the script execution, if the context does not chose to mask the exception

## Typedefs

typedef unsigned long long NV::Rules::ContextHandle