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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan / Server Technology Xerus™ PDU JSON-RPC API: dsam::DsamManager 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 / Server Technology Xerus™ PDU JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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"><b>dsam</b></li><li class="navelem"><a class="el" href="interfacedsam_1_1DsamManager.html">DsamManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="interfacedsam_1_1DsamManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dsam::DsamManager Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>DSAM manager interface.
<a href="interfacedsam_1_1DsamManager.html#details">More...</a></p>
<p><code>import"<a class="el" href="DsamManager_8idl_source.html">DsamManager.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="structdsam_1_1DsamManager_1_1DsamAttachedEvent.html">DsamAttachedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event that is send when a DSAM module has been attached. <a href="structdsam_1_1DsamManager_1_1DsamAttachedEvent.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="structdsam_1_1DsamManager_1_1DsamControllerChangedEvent.html">DsamControllerChangedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event that is send when a DSAM controller has been reset or recovery is in progress. <a href="structdsam_1_1DsamManager_1_1DsamControllerChangedEvent.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="structdsam_1_1DsamManager_1_1DsamDetachedEvent.html">DsamDetachedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event that is send when a DSAM module has been removed. <a href="structdsam_1_1DsamManager_1_1DsamDetachedEvent.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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac437c7fd8b7748ac85cd0c089f4461d1"><td class="memItemLeft" align="right" valign="top">map< int, <a class="el" href="interfacedsam_1_1DsamDevice.html">DsamDevice</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacedsam_1_1DsamManager.html#ac437c7fd8b7748ac85cd0c089f4461d1">getDsamDevices</a> ()</td></tr>
<tr class="memdesc:ac437c7fd8b7748ac85cd0c089f4461d1"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the current DSAM devices. <a href="interfacedsam_1_1DsamManager.html#ac437c7fd8b7748ac85cd0c089f4461d1">More...</a><br /></td></tr>
<tr class="separator:ac437c7fd8b7748ac85cd0c089f4461d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06c3f975093746b0bdf4f3daf9db8112"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdsam_1_1DsamDevice_1_1FirmwareVersion.html">DsamDevice::FirmwareVersion</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacedsam_1_1DsamManager.html#a06c3f975093746b0bdf4f3daf9db8112">getFirmwareUpdateFileVersion</a> ()</td></tr>
<tr class="memdesc:a06c3f975093746b0bdf4f3daf9db8112"><td class="mdescLeft"> </td><td class="mdescRight">Get the version of the firmware file provided with the device that will be installed on the DSAM either by explicit request or when the DSAM needs to be recovered. <a href="interfacedsam_1_1DsamManager.html#a06c3f975093746b0bdf4f3daf9db8112">More...</a><br /></td></tr>
<tr class="separator:a06c3f975093746b0bdf4f3daf9db8112"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>DSAM manager interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac437c7fd8b7748ac85cd0c089f4461d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac437c7fd8b7748ac85cd0c089f4461d1">◆ </a></span>getDsamDevices()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">map<int, <a class="el" href="interfacedsam_1_1DsamDevice.html">DsamDevice</a>> dsam::DsamManager::getDsamDevices </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the current DSAM devices. </p>
<dl class="section return"><dt>Returns</dt><dd>Map with DSAM devices. Index is the DSAM number (1-based). </dd></dl>
</div>
</div>
<a id="a06c3f975093746b0bdf4f3daf9db8112"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06c3f975093746b0bdf4f3daf9db8112">◆ </a></span>getFirmwareUpdateFileVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdsam_1_1DsamDevice_1_1FirmwareVersion.html">DsamDevice::FirmwareVersion</a> dsam::DsamManager::getFirmwareUpdateFileVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version of the firmware file provided with the device that will be installed on the DSAM either by explicit request or when the DSAM needs to be recovered. </p>
<dl class="section return"><dt>Returns</dt><dd>Firmware version </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="DsamManager_8idl_source.html">DsamManager.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
