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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>NvRulesAPI: NV::Rules::INvtxRange Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><b>NV</b>::<b>Rules</b>::<a class="el" href="classNV_1_1Rules_1_1INvtxRange.html">INvtxRange</a>
</div>
</div>
<div class="contents">
<h1>NV::Rules::INvtxRange Class Reference<br>
<small>
[<a class="el" href="group__NVRULES__LW.html">NvRules Python garbage-collected classes.</a>]</small>
</h1><!-- doxytag: class="NV::Rules::INvtxRange" -->NvtxRange interface.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#89bb12e852893f9d986e644a1313539f">category</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the category attribute value. <a href="#89bb12e852893f9d986e644a1313539f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#64a848c34a773c75766fac158a1c71b6">color</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the color attribute value. <a href="#64a848c34a773c75766fac158a1c71b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9">has_attributes</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the range has event attributes. <a href="#2a46d3b04b6ee6f5975469fca3ac0cd9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#803ffa94f25db245fad39587d749b72b">message</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the message attribute value. <a href="#803ffa94f25db245fad39587d749b72b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#5530853f560b3abbd9489b2047051ff2">name</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the range name. <a href="#5530853f560b3abbd9489b2047051ff2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#4260113bf9ca338725d3ce0d44af42c6">payload_as_double</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the payload attribute value as double (64-bit floating point). <a href="#4260113bf9ca338725d3ce0d44af42c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#7ccaafc8a638e2ccdd296d271fa33f13">payload_as_string</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the payload attribute value as a string. <a href="#7ccaafc8a638e2ccdd296d271fa33f13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#a179dee9b8f7868f815a3b376e1a22ad">payload_as_uint64</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the payload attribute value as uint64. <a href="#a179dee9b8f7868f815a3b376e1a22ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PayloadType </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#84dabfe74724ad3ba2df239828f9e6d9">payload_type</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the payload attribute type. <a href="#84dabfe74724ad3ba2df239828f9e6d9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a single NVTX Push/Pop or Start/End range. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="89bb12e852893f9d986e644a1313539f"></a><!-- doxytag: member="NV::Rules::INvtxRange::category" ref="89bb12e852893f9d986e644a1313539f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t NV::Rules::INvtxRange::category </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the category attribute value. If <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9" title="Check if the range has event attributes.">INvtxRange::has_attributes</a> returns false, the returned value is undefined.
</div>
</div><p>
<a class="anchor" name="64a848c34a773c75766fac158a1c71b6"></a><!-- doxytag: member="NV::Rules::INvtxRange::color" ref="64a848c34a773c75766fac158a1c71b6" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t NV::Rules::INvtxRange::color </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the color attribute value. If <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9" title="Check if the range has event attributes.">INvtxRange::has_attributes</a> returns false, the returned value is undefined.
</div>
</div><p>
<a class="anchor" name="2a46d3b04b6ee6f5975469fca3ac0cd9"></a><!-- doxytag: member="NV::Rules::INvtxRange::has_attributes" ref="2a46d3b04b6ee6f5975469fca3ac0cd9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NV::Rules::INvtxRange::has_attributes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the range has event attributes, such as <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#64a848c34a773c75766fac158a1c71b6" title="Get the color attribute value.">INvtxRange::color</a>, <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#89bb12e852893f9d986e644a1313539f" title="Get the category attribute value.">INvtxRange::category</a>, or <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#803ffa94f25db245fad39587d749b72b" title="Get the message attribute value.">INvtxRange::message</a>.
</div>
</div><p>
<a class="anchor" name="803ffa94f25db245fad39587d749b72b"></a><!-- doxytag: member="NV::Rules::INvtxRange::message" ref="803ffa94f25db245fad39587d749b72b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string NV::Rules::INvtxRange::message </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the message attribute value. If <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9" title="Check if the range has event attributes.">INvtxRange::has_attributes</a> returns false, the returned value is undefined.
</div>
</div><p>
<a class="anchor" name="5530853f560b3abbd9489b2047051ff2"></a><!-- doxytag: member="NV::Rules::INvtxRange::name" ref="5530853f560b3abbd9489b2047051ff2" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string NV::Rules::INvtxRange::name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this range
</div>
</div><p>
<a class="anchor" name="4260113bf9ca338725d3ce0d44af42c6"></a><!-- doxytag: member="NV::Rules::INvtxRange::payload_as_double" ref="4260113bf9ca338725d3ce0d44af42c6" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double NV::Rules::INvtxRange::payload_as_double </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload attribute value as a double (64-bit floating point). If the <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#84dabfe74724ad3ba2df239828f9e6d9" title="Get the payload attribute type.">INvtxRange::payload_type</a> cannot be casted to double, the returned value is undefined. If <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9" title="Check if the range has event attributes.">INvtxRange::has_attributes</a> returns false, the returned value is undefined.
</div>
</div><p>
<a class="anchor" name="7ccaafc8a638e2ccdd296d271fa33f13"></a><!-- doxytag: member="NV::Rules::INvtxRange::payload_as_string" ref="7ccaafc8a638e2ccdd296d271fa33f13" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string NV::Rules::INvtxRange::payload_as_string </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload attribute value as a string. If the <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#84dabfe74724ad3ba2df239828f9e6d9" title="Get the payload attribute type.">INvtxRange::payload_type</a> cannot be casted to a string, the returned value is undefined. If <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9" title="Check if the range has event attributes.">INvtxRange::has_attributes</a> returns false, the returned value is undefined.
</div>
</div><p>
<a class="anchor" name="a179dee9b8f7868f815a3b376e1a22ad"></a><!-- doxytag: member="NV::Rules::INvtxRange::payload_as_uint64" ref="a179dee9b8f7868f815a3b376e1a22ad" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t NV::Rules::INvtxRange::payload_as_uint64 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload attribute value as a uint64. If the <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#84dabfe74724ad3ba2df239828f9e6d9" title="Get the payload attribute type.">INvtxRange::payload_type</a> cannot be casted to uint64, the returned value is undefined. If <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9" title="Check if the range has event attributes.">INvtxRange::has_attributes</a> returns false, the returned value is undefined.
</div>
</div><p>
<a class="anchor" name="84dabfe74724ad3ba2df239828f9e6d9"></a><!-- doxytag: member="NV::Rules::INvtxRange::payload_type" ref="84dabfe74724ad3ba2df239828f9e6d9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PayloadType NV::Rules::INvtxRange::payload_type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload attribute type. If <a class="el" href="classNV_1_1Rules_1_1INvtxRange.html#2a46d3b04b6ee6f5975469fca3ac0cd9" title="Check if the range has event attributes.">INvtxRange::has_attributes</a> returns false, the returned type is undefined.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 24 21:21:30 2022 for NvRulesAPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
