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
|
<!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::IMetric 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_1IMetric.html">IMetric</a>
</div>
</div>
<div class="contents">
<h1>NV::Rules::IMetric Class Reference<br>
<small>
[<a class="el" href="group__NVRULES__LW.html">NvRules Python garbage-collected classes.</a>]</small>
</h1><!-- doxytag: class="NV::Rules::IMetric" -->Metric 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 double </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IMetric.html#dd638709eb46c42a2eb391c2b248e564">as_double</a> (size_t instance)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a value from the metric list as double. <a href="#dd638709eb46c42a2eb391c2b248e564"></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_1IMetric.html#8ab4e3bc71a2944a13fafd5c17ef129f">as_double</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metric value as double. <a href="#8ab4e3bc71a2944a13fafd5c17ef129f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IMetric.html#0b123efe38e009c645f4e934d242e7ab">as_string</a> (size_t instance)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a value from the metric list as string. <a href="#0b123efe38e009c645f4e934d242e7ab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IMetric.html#3b61e1e846fc00db6979d71bf58ec59c">as_string</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metric value as string. <a href="#3b61e1e846fc00db6979d71bf58ec59c"></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_1IMetric.html#a0897b7c177157fc5074ce8a391e0704">as_uint64</a> (size_t instance)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a value from the metric list as 64bit integer. <a href="#a0897b7c177157fc5074ce8a391e0704"></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_1IMetric.html#d61365e0f757a5271244a0ff528e3494">as_uint64</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metric value as 64bit integer. <a href="#d61365e0f757a5271244a0ff528e3494"></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_1IMetric.html#61ddb77871e0312cf149bd6c8665aa7b">has_value</a> (ValueKind value_kind)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the metric has a value of a specific kind. <a href="#61ddb77871e0312cf149bd6c8665aa7b"></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_1IMetric.html#206afebbf08d13efdd35a78105258a7c">has_value</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the metric has a non-instanced value. <a href="#206afebbf08d13efdd35a78105258a7c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ValueKind </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IMetric.html#72b08b025806ef5c131edda9f89ff2a6">kind</a> (size_t instance)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metric list entry value kind. <a href="#72b08b025806ef5c131edda9f89ff2a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ValueKind </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IMetric.html#10ffab980e50b79b18fdb2b671b199a9">kind</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metric value kind. <a href="#10ffab980e50b79b18fdb2b671b199a9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IMetric.html#b5771110a77f47a30e778bf021edbc38">name</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metric name. <a href="#b5771110a77f47a30e778bf021edbc38"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IMetric.html#e16ec48cbc1c72547ca4a71ebed19ed1">num_instances</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of values in the metric list. <a href="#e16ec48cbc1c72547ca4a71ebed19ed1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a single, named metric. A metric can carry one value or multiple, if it is an instanced metric. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="dd638709eb46c42a2eb391c2b248e564"></a><!-- doxytag: member="NV::Rules::IMetric::as_double" ref="dd638709eb46c42a2eb391c2b248e564" args="(size_t instance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double NV::Rules::IMetric::as_double </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>instance</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a value <code>instance</code> from the metric list as double
</div>
</div><p>
<a class="anchor" name="8ab4e3bc71a2944a13fafd5c17ef129f"></a><!-- doxytag: member="NV::Rules::IMetric::as_double" ref="8ab4e3bc71a2944a13fafd5c17ef129f" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double NV::Rules::IMetric::as_double </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the metric value as double
</div>
</div><p>
<a class="anchor" name="0b123efe38e009c645f4e934d242e7ab"></a><!-- doxytag: member="NV::Rules::IMetric::as_string" ref="0b123efe38e009c645f4e934d242e7ab" args="(size_t instance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* NV::Rules::IMetric::as_string </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>instance</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a value <code>instance</code> from the metric list as string
</div>
</div><p>
<a class="anchor" name="3b61e1e846fc00db6979d71bf58ec59c"></a><!-- doxytag: member="NV::Rules::IMetric::as_string" ref="3b61e1e846fc00db6979d71bf58ec59c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* NV::Rules::IMetric::as_string </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the metric value as string
</div>
</div><p>
<a class="anchor" name="a0897b7c177157fc5074ce8a391e0704"></a><!-- doxytag: member="NV::Rules::IMetric::as_uint64" ref="a0897b7c177157fc5074ce8a391e0704" args="(size_t instance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t NV::Rules::IMetric::as_uint64 </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>instance</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a value <code>instance</code> from the metric list as 64bit integer
</div>
</div><p>
<a class="anchor" name="d61365e0f757a5271244a0ff528e3494"></a><!-- doxytag: member="NV::Rules::IMetric::as_uint64" ref="d61365e0f757a5271244a0ff528e3494" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t NV::Rules::IMetric::as_uint64 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the metric value as 64bit integer
</div>
</div><p>
<a class="anchor" name="61ddb77871e0312cf149bd6c8665aa7b"></a><!-- doxytag: member="NV::Rules::IMetric::has_value" ref="61ddb77871e0312cf149bd6c8665aa7b" args="(ValueKind value_kind)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NV::Rules::IMetric::has_value </td>
<td>(</td>
<td class="paramtype">ValueKind </td>
<td class="paramname"> <em>value_kind</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the metric has a value of a specific <code>value_kind</code>
</div>
</div><p>
<a class="anchor" name="206afebbf08d13efdd35a78105258a7c"></a><!-- doxytag: member="NV::Rules::IMetric::has_value" ref="206afebbf08d13efdd35a78105258a7c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NV::Rules::IMetric::has_value </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the metric has a non-instanced value. If true, the metric may still have instance values, too.
</div>
</div><p>
<a class="anchor" name="72b08b025806ef5c131edda9f89ff2a6"></a><!-- doxytag: member="NV::Rules::IMetric::kind" ref="72b08b025806ef5c131edda9f89ff2a6" args="(size_t instance)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ValueKind NV::Rules::IMetric::kind </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>instance</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the metric list entry value kind
</div>
</div><p>
<a class="anchor" name="10ffab980e50b79b18fdb2b671b199a9"></a><!-- doxytag: member="NV::Rules::IMetric::kind" ref="10ffab980e50b79b18fdb2b671b199a9" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ValueKind NV::Rules::IMetric::kind </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the metric value kind
</div>
</div><p>
<a class="anchor" name="b5771110a77f47a30e778bf021edbc38"></a><!-- doxytag: member="NV::Rules::IMetric::name" ref="b5771110a77f47a30e778bf021edbc38" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* NV::Rules::IMetric::name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the metric name
</div>
</div><p>
<a class="anchor" name="e16ec48cbc1c72547ca4a71ebed19ed1"></a><!-- doxytag: member="NV::Rules::IMetric::num_instances" ref="e16ec48cbc1c72547ca4a71ebed19ed1" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t NV::Rules::IMetric::num_instances </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of values in the metric list
</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>
|
