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
|
<!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::IContext 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_1IContext.html">IContext</a>
</div>
</div>
<div class="contents">
<h1>NV::Rules::IContext Class Reference<br>
<small>
[<a class="el" href="group__NVRULES__HW.html">NvRules Tool lifetime-managed classes.</a>]</small>
</h1><!-- doxytag: class="NV::Rules::IContext" --><!-- doxytag: inherits="NV::Rules::IBaseContext" -->Context interface.
<a href="#_details">More...</a>
<p>
Inherits NV::Rules::IBaseContext.
<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 <a class="el" href="classNV_1_1Rules_1_1IController.html">IController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IContext.html#9babfd8b141225b911ddb5e8ab2c6fa8">controller</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the controller object. <a href="#9babfd8b141225b911ddb5e8ab2c6fa8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classNV_1_1Rules_1_1IFrontend.html">IFrontend</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IContext.html#c27bde93bab5d35e5f29d3502e358ccc">frontend</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the frontend object. <a href="#c27bde93bab5d35e5f29d3502e358ccc"></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_1IBaseContext.html#b4abb501227aabd4ccb4cf286a096eaf">get_version</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get version number of this interface. <a href="#b4abb501227aabd4ccb4cf286a096eaf"></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_1IBaseContext.html#f49061bef19319be9db9da60f584dd41">handle_exception</a> (const char *msg)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Context exception handler. <a href="#f49061bef19319be9db9da60f584dd41"></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_1IContext.html#15312e7abdc1fbb58fa0e56c325fb1ad">num_ranges</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available ranges. <a href="#15312e7abdc1fbb58fa0e56c325fb1ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classNV_1_1Rules_1_1IRange.html">IRange</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IContext.html#9191f917750cd2418702c018d9f1dc41">range_by_idx</a> (size_t idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a single range by index. <a href="#9191f917750cd2418702c018d9f1dc41"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The rule context provides the rule with access to all collected data, properties and means to relay results back to the caller. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9babfd8b141225b911ddb5e8ab2c6fa8"></a><!-- doxytag: member="NV::Rules::IContext::controller" ref="9babfd8b141225b911ddb5e8ab2c6fa8" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classNV_1_1Rules_1_1IController.html">IController</a>* NV::Rules::IContext::controller </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="classNV_1_1Rules_1_1IController.html" title="Controller interface.">IController</a> object
</div>
</div><p>
<a class="anchor" name="c27bde93bab5d35e5f29d3502e358ccc"></a><!-- doxytag: member="NV::Rules::IContext::frontend" ref="c27bde93bab5d35e5f29d3502e358ccc" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classNV_1_1Rules_1_1IFrontend.html">IFrontend</a>* NV::Rules::IContext::frontend </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="classNV_1_1Rules_1_1IFrontend.html" title="Frontend interface.">IFrontend</a> object
</div>
</div><p>
<a class="anchor" name="b4abb501227aabd4ccb4cf286a096eaf"></a><!-- doxytag: member="NV::Rules::IContext::get_version" ref="b4abb501227aabd4ccb4cf286a096eaf" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string NV::Rules::IBaseContext::get_version </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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.
</div>
</div><p>
<a class="anchor" name="f49061bef19319be9db9da60f584dd41"></a><!-- doxytag: member="NV::Rules::IContext::handle_exception" ref="f49061bef19319be9db9da60f584dd41" args="(const char *msg)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool NV::Rules::IBaseContext::handle_exception </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td><code> [pure virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Should return true if a python exception should be set, false otherwise
</div>
</div><p>
<a class="anchor" name="15312e7abdc1fbb58fa0e56c325fb1ad"></a><!-- doxytag: member="NV::Rules::IContext::num_ranges" ref="15312e7abdc1fbb58fa0e56c325fb1ad" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t NV::Rules::IContext::num_ranges </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 available ranges
</div>
</div><p>
<a class="anchor" name="9191f917750cd2418702c018d9f1dc41"></a><!-- doxytag: member="NV::Rules::IContext::range_by_idx" ref="9191f917750cd2418702c018d9f1dc41" args="(size_t idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classNV_1_1Rules_1_1IRange.html">IRange</a>* NV::Rules::IContext::range_by_idx </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a single <a class="el" href="classNV_1_1Rules_1_1IRange.html" title="Range interface.">IRange</a> by index
</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>
|
