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
|
<!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: modbus::GatewayMgr 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"><b>modbus</b></li><li class="navelem"><a class="el" href="interfacemodbus_1_1GatewayMgr.html">GatewayMgr</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="#pub-attribs">Public Attributes</a> |
<a href="interfacemodbus_1_1GatewayMgr-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">modbus::GatewayMgr Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<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="structmodbus_1_1GatewayMgr_1_1RtuSettings.html">RtuSettings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Modbus RTU settings. <a href="structmodbus_1_1GatewayMgr_1_1RtuSettings.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="structmodbus_1_1GatewayMgr_1_1Settings.html">Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Modbus gateway settings (extending modb PortMux service) <a href="structmodbus_1_1GatewayMgr_1_1Settings.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:a96e1a4ebdc7180a8fc0e3eea88e89bcc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmodbus_1_1GatewayMgr_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacemodbus_1_1GatewayMgr.html#a96e1a4ebdc7180a8fc0e3eea88e89bcc">getSettings</a> ()</td></tr>
<tr class="memdesc:a96e1a4ebdc7180a8fc0e3eea88e89bcc"><td class="mdescLeft"> </td><td class="mdescRight">Get the modbus gateway settings. <a href="#a96e1a4ebdc7180a8fc0e3eea88e89bcc">More...</a><br /></td></tr>
<tr class="separator:a96e1a4ebdc7180a8fc0e3eea88e89bcc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a77af97f95a00a3995016ab40a90046"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacemodbus_1_1GatewayMgr.html#a4a77af97f95a00a3995016ab40a90046">setSettings</a> (in <a class="el" href="structmodbus_1_1GatewayMgr_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:a4a77af97f95a00a3995016ab40a90046"><td class="mdescLeft"> </td><td class="mdescRight">Set the modbus gateway settings. <a href="#a4a77af97f95a00a3995016ab40a90046">More...</a><br /></td></tr>
<tr class="separator:a4a77af97f95a00a3995016ab40a90046"><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:ab1c5b6187c018b571a3fa5b54f0c9278"><td class="memItemLeft" align="right" valign="top"><a id="ab1c5b6187c018b571a3fa5b54f0c9278"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacemodbus_1_1GatewayMgr.html#ab1c5b6187c018b571a3fa5b54f0c9278">NO_ERROR</a> = 0</td></tr>
<tr class="memdesc:ab1c5b6187c018b571a3fa5b54f0c9278"><td class="mdescLeft"> </td><td class="mdescRight">No error. <br /></td></tr>
<tr class="separator:ab1c5b6187c018b571a3fa5b54f0c9278"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05f1bbcf53b223cf4d9bb7e665b69c9e"><td class="memItemLeft" align="right" valign="top"><a id="a05f1bbcf53b223cf4d9bb7e665b69c9e"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacemodbus_1_1GatewayMgr.html#a05f1bbcf53b223cf4d9bb7e665b69c9e">ERR_INVALID_PARAMS</a> = 1</td></tr>
<tr class="memdesc:a05f1bbcf53b223cf4d9bb7e665b69c9e"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameters. <br /></td></tr>
<tr class="separator:a05f1bbcf53b223cf4d9bb7e665b69c9e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a96e1a4ebdc7180a8fc0e3eea88e89bcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96e1a4ebdc7180a8fc0e3eea88e89bcc">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmodbus_1_1GatewayMgr_1_1Settings.html">Settings</a> modbus::GatewayMgr::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the modbus gateway settings. </p>
<dl class="section return"><dt>Returns</dt><dd>settings </dd></dl>
</div>
</div>
<a id="a4a77af97f95a00a3995016ab40a90046"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a77af97f95a00a3995016ab40a90046">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int modbus::GatewayMgr::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structmodbus_1_1GatewayMgr_1_1Settings.html">Settings</a> </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the modbus gateway settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
ERR_INVALID_PARAMS if any parameters are invalid </dd></dl>
</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="ModbusGatewayMgr_8idl_source.html">ModbusGatewayMgr.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>
|
