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
|
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: assetmgrmodel::AssetStripLogger_1_0_6 Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceassetmgrmodel.html">assetmgrmodel</a></li><li class="navelem"><a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html">AssetStripLogger_1_0_6</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">assetmgrmodel::AssetStripLogger_1_0_6 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Asset Strip Logger interface.
<a href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#details">More...</a></p>
<p><code>import"<a class="el" href="AssetStripLogger_8idl_source.html">AssetStripLogger.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Info.html">Info</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Log information structure. <a href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Info.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Record.html">Record</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Log record structure. <a href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Record.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa00987cfc45eaa42ad24768cceef328f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa00987cfc45eaa42ad24768cceef328f">RecordType</a> { <a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa00987cfc45eaa42ad24768cceef328fa4b21cd38bec6c573a7530470b1e9587c">EMPTY</a>,
<a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa00987cfc45eaa42ad24768cceef328fa117aef461e8205f2d0a1787f854b55bc">ASSET_TAG_CONNECTED</a>,
<a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa00987cfc45eaa42ad24768cceef328fac9eb10ac00d2568bb44fd51c7066fa1e">ASSET_TAG_DISCONNECTED</a>,
<a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa00987cfc45eaa42ad24768cceef328fa31ba37ea672723b574d9a1aaa144f0a1">ASSET_STRIP_STATE_CHANGED</a>
}</td></tr>
<tr class="memdesc:aa00987cfc45eaa42ad24768cceef328f"><td class="mdescLeft"> </td><td class="mdescRight">Log record type. <a href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa00987cfc45eaa42ad24768cceef328f">More...</a><br /></td></tr>
<tr class="separator:aa00987cfc45eaa42ad24768cceef328f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad4dff9c936b660987d02ee94c1cc0d41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Info.html">Info</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#ad4dff9c936b660987d02ee94c1cc0d41">getInfo</a> ()</td></tr>
<tr class="memdesc:ad4dff9c936b660987d02ee94c1cc0d41"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the log information. <a href="#ad4dff9c936b660987d02ee94c1cc0d41">More...</a><br /></td></tr>
<tr class="separator:ad4dff9c936b660987d02ee94c1cc0d41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26a8a95cf0927f19de97917db10b2f05"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#a26a8a95cf0927f19de97917db10b2f05">getRecords</a> (out vector< <a class="el" href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Record.html">Record</a> > records, in int id, in int count)</td></tr>
<tr class="memdesc:a26a8a95cf0927f19de97917db10b2f05"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve records from the log ring buffer. <a href="#a26a8a95cf0927f19de97917db10b2f05">More...</a><br /></td></tr>
<tr class="separator:a26a8a95cf0927f19de97917db10b2f05"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af49ce72db5b817f70533fc207b5a0197"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#af49ce72db5b817f70533fc207b5a0197">NO_ERROR</a> = 0</td></tr>
<tr class="memdesc:af49ce72db5b817f70533fc207b5a0197"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="#af49ce72db5b817f70533fc207b5a0197">More...</a><br /></td></tr>
<tr class="separator:af49ce72db5b817f70533fc207b5a0197"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9af1c5c424678b0c41f01c1ac98debf"><td class="memItemLeft" align="right" valign="top"><a id="aa9af1c5c424678b0c41f01c1ac98debf"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa9af1c5c424678b0c41f01c1ac98debf">ERR_INVALID_PARAM</a> = 1</td></tr>
<tr class="memdesc:aa9af1c5c424678b0c41f01c1ac98debf"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameter. <br /></td></tr>
<tr class="separator:aa9af1c5c424678b0c41f01c1ac98debf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Asset Strip Logger interface. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aa00987cfc45eaa42ad24768cceef328f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa00987cfc45eaa42ad24768cceef328f">◆ </a></span>RecordType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceassetmgrmodel_1_1AssetStripLogger__1__0__6.html#aa00987cfc45eaa42ad24768cceef328f">assetmgrmodel::AssetStripLogger_1_0_6::RecordType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Log record type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa00987cfc45eaa42ad24768cceef328fa4b21cd38bec6c573a7530470b1e9587c"></a>EMPTY </td><td class="fielddoc"><p>The log record is empty. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa00987cfc45eaa42ad24768cceef328fa117aef461e8205f2d0a1787f854b55bc"></a>ASSET_TAG_CONNECTED </td><td class="fielddoc"><p>An asset tag has been connected. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa00987cfc45eaa42ad24768cceef328fac9eb10ac00d2568bb44fd51c7066fa1e"></a>ASSET_TAG_DISCONNECTED </td><td class="fielddoc"><p>An asset tag has been disconnected. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa00987cfc45eaa42ad24768cceef328fa31ba37ea672723b574d9a1aaa144f0a1"></a>ASSET_STRIP_STATE_CHANGED </td><td class="fielddoc"><p>The state of the asset strip changed. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad4dff9c936b660987d02ee94c1cc0d41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4dff9c936b660987d02ee94c1cc0d41">◆ </a></span>getInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Info.html">Info</a> assetmgrmodel::AssetStripLogger_1_0_6::getInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the log information. </p>
<dl class="section return"><dt>Returns</dt><dd>Log information </dd></dl>
</div>
</div>
<a id="a26a8a95cf0927f19de97917db10b2f05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26a8a95cf0927f19de97917db10b2f05">◆ </a></span>getRecords()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int assetmgrmodel::AssetStripLogger_1_0_6::getRecords </td>
<td>(</td>
<td class="paramtype">out vector< <a class="el" href="structassetmgrmodel_1_1AssetStripLogger__1__0__6_1_1Record.html">Record</a> > </td>
<td class="paramname"><em>records</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in int </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve records from the log ring buffer. </p>
<p>This method is used to read one or more records from the log ring buffer. It is allowed to read unused entries. The record index will wrap to 0 when reading beyond the end of the log.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">records</td><td>Result: The requested log entries </td></tr>
<tr><td class="paramname">id</td><td>Index of the first log index to read (0..capacity) </td></tr>
<tr><td class="paramname">count</td><td>Number of records to read (1..capacity)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR on success </dd>
<dd>
ERR_INVALID_PARAM if any parameter is out of range </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af49ce72db5b817f70533fc207b5a0197"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af49ce72db5b817f70533fc207b5a0197">◆ </a></span>NO_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int assetmgrmodel::AssetStripLogger_1_0_6::NO_ERROR = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<p>Operation successful, no error </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="AssetStripLogger_8idl_source.html">AssetStripLogger.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
