1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
<meta http-equiv="X-UA-Compatible" content="IE=edge"></meta>
<meta name="copyright" content="(C) Copyright 2005"></meta>
<meta name="DC.rights.owner" content="(C) Copyright 2005"></meta>
<meta name="DC.Type" content="reference"></meta>
<meta name="DC.Title" content="Modules"></meta>
<meta name="DC.Format" content="XHTML"></meta>
<meta name="DC.Identifier" content="modules"></meta>
<link rel="stylesheet" type="text/css" href="../common/formatting/commonltr.css"></link>
<link rel="stylesheet" type="text/css" href="../common/formatting/site.css"></link>
<title>NvRules API :: Nsight Compute Documentation</title>
<!--[if lt IE 9]>
<script src="../common/formatting/html5shiv-printshiv.min.js"></script>
<![endif]-->
<script type="text/javascript" charset="utf-8" src="../common/scripts/tynt/tynt.js"></script>
-->
<script src="https://assets.adobedtm.com/5d4962a43b79/c1061d2c5e7b/launch-191c2462b890.min.js"></script>
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.min.js"></script>
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.ba-hashchange.min.js"></script>
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.scrollintoview.min.js"></script>
<script type="text/javascript" src="../search/htmlFileList.js"></script>
<script type="text/javascript" src="../search/htmlFileInfoList.js"></script>
<script type="text/javascript" src="../search/nwSearchFnt.min.js"></script>
<script type="text/javascript" src="../search/stemmers/en_stemmer.min.js"></script>
<script type="text/javascript" src="../search/index-1.js"></script>
<script type="text/javascript" src="../search/index-2.js"></script>
<script type="text/javascript" src="../search/index-3.js"></script>
<link rel="canonical" href="https://developer.nvidia.com/NvRulesAPI/index.html"></link>
<link rel="stylesheet" type="text/css" href="../common/formatting/qwcode.highlight.css"></link>
</head>
<body>
<header id="header"><span id="company">NVIDIA</span><span id="site-title">Nsight Compute Documentation</span><form id="search" method="get" action="search">
<input type="text" name="search-text"></input><fieldset id="search-location">
<legend>Search In:</legend>
<label><input type="radio" name="search-type" value="site"></input>Entire Site</label>
<label><input type="radio" name="search-type" value="document"></input>Just This Document</label></fieldset>
<button type="reset">clear search</button>
<button id="submit" type="submit">search</button></form>
</header>
<div id="site-content">
<nav id="site-nav">
<div class="category closed"><a href="../index.html" title="The root of the site.">Nsight Compute
v2022.3.0</a></div>
<div class="category"><a href="index.html" title="NvRules API">NvRules API</a></div>
<ul>
<li>
<div class="section-link"><a href="modules.html#modules">1. Modules</a></div>
<ul>
<li>
<div class="section-link"><a href="modules.html#group__NVRULES__NM">1.1. NvRules non-member functions.</a></div>
</li>
<li>
<div class="section-link"><a href="modules.html#group__NVRULES__LW">1.2. NvRules Python garbage-collected classes.</a></div>
</li>
<li>
<div class="section-link"><a href="modules.html#group__NVRULES__HW">1.3. NvRules Tool lifetime-managed classes.</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="annotated.html#annotated">2. Data Structures</a></div>
<ul>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1IAction">2.1. NV::Rules::IAction</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1IContext">2.2. NV::Rules::IContext</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1IController">2.3. NV::Rules::IController</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1IEvaluator">2.4. NV::Rules::IEvaluator</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1IFrontend">2.5. NV::Rules::IFrontend</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1IMetric">2.6. NV::Rules::IMetric</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1INvtxDomainInfo">2.7. NV::Rules::INvtxDomainInfo</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1INvtxRange">2.8. NV::Rules::INvtxRange</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1INvtxState">2.9. NV::Rules::INvtxState</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1IRange">2.10. NV::Rules::IRange</a></div>
</li>
<li>
<div class="section-link"><a href="annotated.html#classNV_1_1Rules_1_1ISourceInfo">2.11. NV::Rules::ISourceInfo</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="functions.html#functions">3. Data Fields</a></div>
</li>
<li>
<div class="section-link"><a href="notices-header.html#notices-header">Notices</a></div>
<ul></ul>
</li>
</ul>
</nav>
<div id="resize-nav"></div>
<nav id="search-results">
<h2>Search Results</h2>
<ol></ol>
</nav>
<div id="contents-container">
<div id="breadcrumbs-container">
<div id="breadcrumbs"><a href="index.html" shape="rect">< Previous</a> | <a href="annotated.html" shape="rect">Next ></a></div>
<div id="release-info">NvRules API
(<a href="../pdf/NvRulesAPI.pdf">PDF</a>)
-
v2022.3.0
(<a href="https://developer.nvidia.com">older</a>)
-
Last updated August 24, 2022
-
<a href="mailto:devtools@nvidia.com?subject=Nsight Compute Documentation Feedback: NvRules API">Send Feedback</a>
-
<span class="st_facebook"></span><span class="st_twitter"></span><span class="st_linkedin"></span><span class="st_reddit"></span><span class="st_slashdot"></span><span class="st_tumblr"></span><span class="st_sharethis"></span></div>
</div>
<article id="contents">
<div class="topic nested1" id="modules"><a name="modules" shape="rect">
<!-- --></a><h2 class="topictitle2">1. Modules</h2>
<div class="body refbody">
<div class="section">
<p class="p">Here is a list of all modules:</p>
</div>
<div class="section">
<ul class="ul">
<li class="li cpp_specialisation"><a class="xref" href="modules.html#group__NVRULES__NM" title="Non-member utility functions." shape="rect">NvRules non-member functions.</a></li>
<li class="li cpp_specialisation"><a class="xref" href="modules.html#group__NVRULES__LW" title="Objects of lightweight classes are garbage-collected by the python runtime." shape="rect">NvRules Python garbage-collected classes.</a></li>
<li class="li cpp_specialisation"><a class="xref" href="modules.html#group__NVRULES__HW" title="Objects of heavyweight classes are lifetime-managed by the tool." shape="rect">NvRules Tool lifetime-managed classes.</a></li>
</ul>
</div>
</div>
<div class="topic reference apiRef apiPackage cppModule" id="group__NVRULES__NM"><a name="group__NVRULES__NM" shape="rect">
<!-- --></a><h3 class="topictitle3 cppModule">1.1. NvRules non-member functions.</h3>
<div class="section">
<p></p>
</div>
<h4 class="fake_sectiontitle member_header">Functions</h4>
<dl class="members">
<dt><span class="member_type">IContext* </span><span class="member_name"><a href="#group__NVRULES__NM_1g21f96fa3e5314fea33ed395fc59bc3a6" shape="rect">NV::Rules::get_context</a> ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Converts the context handle. </span></dd>
<dt><span class="member_type">IEvaluator* </span><span class="member_name"><a href="#group__NVRULES__NM_1ga1ef938d12d653281c08a7b946bf0f51" shape="rect">NV::Rules::get_evaluator</a> ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Returns the evaluator object. </span></dd>
<dt><span class="member_type">std::​string </span><span class="member_name"><a href="#group__NVRULES__NM_1g9dce07e8e99cf88e06a47095d9515522" shape="rect">NV::Rules::get_version</a> ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get version number of this interface. </span></dd>
<dt><span class="member_type">void </span><span class="member_name"><a href="#group__NVRULES__NM_1geaa0d437069f2fcc2313627f99338d7e" shape="rect">NV::Rules::raise_exception</a> ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span>, const char*<span> </span><span class="keyword keyword apiItemName">msg</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Raises a python exception. </span></dd>
</dl>
<div class="description">
<h4 class="sectiontitle">Functions</h4>
<dl class="description">
<dt class="description"><a name="group__NVRULES__NM_1g21f96fa3e5314fea33ed395fc59bc3a6" id="group__NVRULES__NM_1g21f96fa3e5314fea33ed395fc59bc3a6" shape="rect">
<!-- --></a><span>IContext* NV::Rules::get_context ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span> ) </span></dt>
<dd class="description">
<div class="section">Converts the context handle. </div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Converts the context handle <tt class="ph tt code">h</tt> to an <a class="xref" href="annotated.html#classNV_1_1Rules_1_1IContext" title="Context interface." shape="rect">IContext</a> object
</p>
</div>
</dd>
<dt class="description"><a name="group__NVRULES__NM_1ga1ef938d12d653281c08a7b946bf0f51" id="group__NVRULES__NM_1ga1ef938d12d653281c08a7b946bf0f51" shape="rect">
<!-- --></a><span>IEvaluator* NV::Rules::get_evaluator ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span> ) </span></dt>
<dd class="description">
<div class="section">Returns the evaluator object. </div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Return the <a class="xref" href="annotated.html#classNV_1_1Rules_1_1IEvaluator" title="Evaluator interface." shape="rect">IEvaluator</a> object from the context handle <tt class="ph tt code">h</tt></p>
</div>
</dd>
<dt class="description"><a name="group__NVRULES__NM_1g9dce07e8e99cf88e06a47095d9515522" id="group__NVRULES__NM_1g9dce07e8e99cf88e06a47095d9515522" shape="rect">
<!-- --></a><span>std::​string NV::Rules::get_version ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span> ) </span></dt>
<dd class="description">
<div class="section">Get version number of this interface. </div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>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.
</p>
</div>
</dd>
<dt class="description"><a name="group__NVRULES__NM_1geaa0d437069f2fcc2313627f99338d7e" id="group__NVRULES__NM_1geaa0d437069f2fcc2313627f99338d7e" shape="rect">
<!-- --></a><span>void NV::Rules::raise_exception ( ContextHandle<span> </span><span class="keyword keyword apiItemName">h</span>, const char*<span> </span><span class="keyword keyword apiItemName">msg</span> ) </span></dt>
<dd class="description">
<div class="section">Raises a python exception. </div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Raise a python exception with <tt class="ph tt code">msg</tt>. This will terminate the script execution, if the context does not chose to mask the exception
</p>
</div>
</dd>
</dl>
</div>
</div>
<div class="topic reference apiRef apiPackage cppModule" id="group__NVRULES__LW"><a name="group__NVRULES__LW" shape="rect">
<!-- --></a><h3 class="topictitle3 cppModule">1.2. NvRules Python garbage-collected classes.</h3>
<div class="section">
<p></p>
</div>
<h4 class="fake_sectiontitle member_header">Classes</h4>
<dl class="members">
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1IAction" title="Action interface." shape="rect">NV::Rules::IAction</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Action interface. </span><a href="annotated.html#classNV_1_1Rules_1_1IAction" class="link" title="Action interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1IMetric" title="Metric interface." shape="rect">NV::Rules::IMetric</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Metric interface. </span><a href="annotated.html#classNV_1_1Rules_1_1IMetric" class="link" title="Metric interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1INvtxDomainInfo" title="NvtxDomainInfo interface." shape="rect">NV::Rules::INvtxDomainInfo</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">NvtxDomainInfo interface. </span><a href="annotated.html#classNV_1_1Rules_1_1INvtxDomainInfo" class="link" title="NvtxDomainInfo interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1INvtxRange" title="NvtxRange interface." shape="rect">NV::Rules::INvtxRange</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">NvtxRange interface. </span><a href="annotated.html#classNV_1_1Rules_1_1INvtxRange" class="link" title="NvtxRange interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1INvtxState" title="NvtxState interface." shape="rect">NV::Rules::INvtxState</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">NvtxState interface. </span><a href="annotated.html#classNV_1_1Rules_1_1INvtxState" class="link" title="NvtxState interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1IRange" title="Range interface." shape="rect">NV::Rules::IRange</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Range interface. </span><a href="annotated.html#classNV_1_1Rules_1_1IRange" class="link" title="Range interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1ISourceInfo" title="SourceInfo interface." shape="rect">NV::Rules::ISourceInfo</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">SourceInfo interface. </span><a href="annotated.html#classNV_1_1Rules_1_1ISourceInfo" class="link" title="SourceInfo interface." shape="rect"></a></dd>
</dl>
</div>
<div class="topic reference apiRef apiPackage cppModule" id="group__NVRULES__HW"><a name="group__NVRULES__HW" shape="rect">
<!-- --></a><h3 class="topictitle3 cppModule">1.3. NvRules Tool lifetime-managed classes.</h3>
<div class="section">
<p></p>
</div>
<h4 class="fake_sectiontitle member_header">Classes</h4>
<dl class="members">
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1IContext" title="Context interface." shape="rect">NV::Rules::IContext</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Context interface. </span><a href="annotated.html#classNV_1_1Rules_1_1IContext" class="link" title="Context interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1IController" title="Controller interface." shape="rect">NV::Rules::IController</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Controller interface. </span><a href="annotated.html#classNV_1_1Rules_1_1IController" class="link" title="Controller interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1IEvaluator" title="Evaluator interface." shape="rect">NV::Rules::IEvaluator</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Evaluator interface. </span><a href="annotated.html#classNV_1_1Rules_1_1IEvaluator" class="link" title="Evaluator interface." shape="rect"></a></dd>
<dt><span class="member_type">class </span><span class="member_name">
<div><a class="link" href="annotated.html#classNV_1_1Rules_1_1IFrontend" title="Frontend interface." shape="rect">NV::Rules::IFrontend</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc">Frontend interface. </span><a href="annotated.html#classNV_1_1Rules_1_1IFrontend" class="link" title="Frontend interface." shape="rect"></a></dd>
</dl>
</div>
</div>
<hr id="contents-end"></hr>
</article>
</div>
</div>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/formatting/common.min.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/google-analytics/google-analytics-write.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/google-analytics/google-analytics-tracker.js"></script>
<script type="text/javascript">_satellite.pageBottom();</script>
<script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript">stLight.options({publisher: "998dc202-a267-4d8e-bce9-14debadb8d92", doNotHash: false, doNotCopy: false, hashAddressBar: false});</script></body>
</html>
|
