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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>NV::Rules::INvtxRange — NsightCompute 12.4 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/design-style.b7bb847fb20b106c3d81b95245e65545.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/omni-style.css" type="text/css" />
<link rel="stylesheet" href="../_static/api-styles.css" type="text/css" />
<link rel="shortcut icon" href="../_static/nsight-compute.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/mermaid-init.js"></script>
<script src="../_static/design-tabs.js"></script>
<script src="../_static/version.js"></script>
<script src="../_static/social-media.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="NV::Rules::INvtxState" href="classNV_1_1Rules_1_1INvtxState.html" />
<link rel="prev" title="NV::Rules::INvtxDomainInfo" href="classNV_1_1Rules_1_1INvtxDomainInfo.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/nsight-compute.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Nsight Compute</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../ReleaseNotes/index.html">1. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ProfilingGuide/index.html">2. Kernel Profiling Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../NsightCompute/index.html">3. Nsight Compute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../NsightComputeCli/index.html">4. Nsight Compute CLI</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer Interfaces</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../CustomizationGuide/index.html">1. Customization Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../NvRulesAPI/index.html">2. NvRules API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="modules.html">2.1. Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="data-structures.html">2.2. Data Structures</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="namespaces.html">2.3. Namespaces</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="namespaceNV.html">2.3.1. NV</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="namespaceNV_1_1Rules.html">Rules</a><ul class="current">
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IAction.html">IAction</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IBaseContext.html">IBaseContext</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IContext.html">IContext</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IController.html">IController</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IEvaluator.html">IEvaluator</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IFrontend.html">IFrontend</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IMessageVault.html">IMessageVault</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IMetric.html">IMetric</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1INvtxDomainInfo.html">INvtxDomainInfo</a></li>
<li class="toctree-l5 current"><a class="current reference internal" href="#">INvtxRange</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1INvtxState.html">INvtxState</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1IRange.html">IRange</a></li>
<li class="toctree-l5"><a class="reference internal" href="classNV_1_1Rules_1_1ISourceInfo.html">ISourceInfo</a></li>
<li class="toctree-l5"><a class="reference internal" href="namespaceNV_1_1Rules.html#enumerations">Enumerations</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Training</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Training/index.html">Training</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Release Information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Archives/index.html">Archives</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Copyright and Licenses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../CopyrightAndLicenses/index.html">Copyright and Licenses</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">NsightCompute</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="../NvRulesAPI/index.html"><span class="section-number">2. </span>NvRules API</a> »</li>
<li><a href="namespaces.html"><span class="section-number">2.3. </span>Namespaces</a> »</li>
<li><a href="namespaceNV.html"><span class="section-number">2.3.1. </span>NV</a> »</li>
<li><a href="namespaceNV_1_1Rules.html">NV::Rules</a> »</li>
<li>NV::Rules::INvtxRange</li>
<li class="wy-breadcrumbs-aside">
</li>
<li class="wy-breadcrumbs-aside">
<span>v2024.1.1 |</span>
<a href="https://developer.nvidia.com/nsight-compute-history" class="reference external">Archive</a>
<span> </span>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="nv-rules-invtxrange">
<h1>NV::Rules::INvtxRange<a class="headerlink" href="#nv-rules-invtxrange" title="Permalink to this headline"></a></h1>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRangeE">
<span id="_CPPv3N2NV5Rules10INvtxRangeE"></span><span id="_CPPv2N2NV5Rules10INvtxRangeE"></span><span id="NV::Rules::INvtxRange"></span><span class="target" id="classnv_1_1rules_1_1invtxrange"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INvtxRange</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRangeE" title="Permalink to this definition"></a><br /></dt>
<dd><p>NvtxRange interface. </p>
<p>Represents a single NVTX Push/Pop or Start/End range. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric-h3 rubric" id="breathe-section-title-public-types">Public Types</p>
<dl class="cpp enum-class">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadTypeE">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadTypeE"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadTypeE"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89b"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PayloadType</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadTypeE" title="Permalink to this definition"></a><br /></dt>
<dd><p>NVTX payload type. </p>
<p>Type of an NVTX payload. This can be used to choose the appropriate payload_as_* function. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType15PAYLOAD_UNKNOWNE">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType15PAYLOAD_UNKNOWNE"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType15PAYLOAD_UNKNOWNE"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89bae126dba74f537b08a1905c5cb4ad0546"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_UNKNOWN</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType15PAYLOAD_UNKNOWNE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT64E">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT64E"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT64E"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89bad6dd8a88eef0a1cb900033a30f07f0e4"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_UINT64</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT64E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT64E">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT64E"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT64E"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89ba0228b7c895fdb68573a36ab32c7d3b10"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_INT64</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT64E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_DOUBLEE">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_DOUBLEE"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_DOUBLEE"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89ba0976f228c20b0288e25f5d8c9fdd8b4e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_DOUBLE</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_DOUBLEE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT32E">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT32E"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT32E"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89bae8ca6e876eb2ff122120b86841f66cfc"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_UINT32</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType14PAYLOAD_UINT32E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT32E">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT32E"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT32E"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89bacf3f5ea84829ad690d77981ee170b248"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_INT32</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_INT32E" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_FLOATE">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_FLOATE"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_FLOATE"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89ba62180712a1a0be64dac6b02448952b5c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_FLOAT</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType13PAYLOAD_FLOATE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRange11PayloadType12PAYLOAD_JSONE">
<span id="_CPPv3N2NV5Rules10INvtxRange11PayloadType12PAYLOAD_JSONE"></span><span id="_CPPv2N2NV5Rules10INvtxRange11PayloadType12PAYLOAD_JSONE"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a6ce0d035337f1e6d28a225748edaa89bab7d78321d3ace7598e34f143cbaa0e0b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PAYLOAD_JSON</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadType12PAYLOAD_JSONE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric-h3 rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange8categoryEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange8categoryEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange8categoryEv"></span><span id="NV::Rules::INvtxRange::categoryC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a89bb12e852893f9d986e644a1313539f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">category</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange8categoryEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the category attribute value. </p>
<p>Get the category attribute value. If INvtxRange::has_attributes returns false, the returned value is undefined. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange5colorEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange5colorEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange5colorEv"></span><span id="NV::Rules::INvtxRange::colorC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a64a848c34a773c75766fac158a1c71b6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">color</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange5colorEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the color attribute value. </p>
<p>Get the color attribute value. If INvtxRange::has_attributes returns false, the returned value is undefined. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange14has_attributesEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange14has_attributesEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange14has_attributesEv"></span><span id="NV::Rules::INvtxRange::has_attributesC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a2a46d3b04b6ee6f5975469fca3ac0cd9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">has_attributes</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange14has_attributesEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Check if the range has event attributes. </p>
<p>Check if the range has event attributes, such as INvtxRange::color, INvtxRange::category, or INvtxRange::message. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange7messageEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange7messageEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange7messageEv"></span><span id="NV::Rules::INvtxRange::messageC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a803ffa94f25db245fad39587d749b72b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">message</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange7messageEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the message attribute value. </p>
<p>Get the message attribute value. If INvtxRange::has_attributes returns false, the returned value is undefined. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange4nameEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange4nameEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange4nameEv"></span><span id="NV::Rules::INvtxRange::nameC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a5530853f560b3abbd9489b2047051ff2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange4nameEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the range name. </p>
<p>Get the name of this range </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange17payload_as_doubleEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange17payload_as_doubleEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange17payload_as_doubleEv"></span><span id="NV::Rules::INvtxRange::payload_as_doubleC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a4260113bf9ca338725d3ce0d44af42c6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">payload_as_double</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange17payload_as_doubleEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the payload attribute value as double (64-bit floating point) </p>
<p>Get the payload attribute value as a double (64-bit floating point). If the INvtxRange::payload_type cannot be casted to double, the returned value is undefined. If INvtxRange::has_attributes returns false, the returned value is undefined. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange17payload_as_stringEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange17payload_as_stringEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange17payload_as_stringEv"></span><span id="NV::Rules::INvtxRange::payload_as_stringC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a7ccaafc8a638e2ccdd296d271fa33f13"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">payload_as_string</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange17payload_as_stringEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the payload attribute value as a string. </p>
<p>Get the payload attribute value as a string. If the INvtxRange::payload_type cannot be casted to a string, the returned value is undefined. If INvtxRange::has_attributes returns false, the returned value is undefined. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange17payload_as_uint64Ev">
<span id="_CPPv3NK2NV5Rules10INvtxRange17payload_as_uint64Ev"></span><span id="_CPPv2NK2NV5Rules10INvtxRange17payload_as_uint64Ev"></span><span id="NV::Rules::INvtxRange::payload_as_uint64C"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1aa179dee9b8f7868f815a3b376e1a22ad"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">payload_as_uint64</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange17payload_as_uint64Ev" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the payload attribute value as uint64. </p>
<p>Get the payload attribute value as a uint64. If the INvtxRange::payload_type cannot be casted to uint64, the returned value is undefined. If INvtxRange::has_attributes returns false, the returned value is undefined. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK2NV5Rules10INvtxRange12payload_typeEv">
<span id="_CPPv3NK2NV5Rules10INvtxRange12payload_typeEv"></span><span id="_CPPv2NK2NV5Rules10INvtxRange12payload_typeEv"></span><span id="NV::Rules::INvtxRange::payload_typeC"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1a84dabfe74724ad3ba2df239828f9e6d9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N2NV5Rules10INvtxRange11PayloadTypeE" title="NV::Rules::INvtxRange::PayloadType"><span class="n"><span class="pre">PayloadType</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">payload_type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK2NV5Rules10INvtxRange12payload_typeEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get the payload attribute type. </p>
<p>Get the payload attribute type. If INvtxRange::has_attributes returns false, the returned type is undefined. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules10INvtxRangeD0Ev">
<span id="_CPPv3N2NV5Rules10INvtxRangeD0Ev"></span><span id="_CPPv2N2NV5Rules10INvtxRangeD0Ev"></span><span id="NV::Rules::INvtxRange::~INvtxRange"></span><span class="target" id="classnv_1_1rules_1_1invtxrange_1ad42c06bf80afa2e70e4ba5cb0134e7a7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~INvtxRange</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N2NV5Rules10INvtxRangeD0Ev" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2018-2024, NVIDIA Corporation & Affiliates. All rights reserved.
<span class="lastupdated">Last updated on Mar 06, 2024.
</span></p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
