Projekt

Obecné

Profil

Stáhnout (19.5 KB) Statistiky
| Větev: | Tag: | Revize:
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<head>
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6
<meta name="generator" content="Doxygen 1.9.4"/>
7
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8
<title>LDClient: LDClient.detection.InfoFetcher Class Reference</title>
9
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10
<script type="text/javascript" src="jquery.js"></script>
11
<script type="text/javascript" src="dynsections.js"></script>
12
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13
<script type="text/javascript" src="resize.js"></script>
14
<script type="text/javascript" src="navtreedata.js"></script>
15
<script type="text/javascript" src="navtree.js"></script>
16
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17
<script type="text/javascript" src="search/searchdata.js"></script>
18
<script type="text/javascript" src="search/search.js"></script>
19
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20
</head>
21
<body>
22
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23
<div id="titlearea">
24
<table cellspacing="0" cellpadding="0">
25
 <tbody>
26
 <tr id="projectrow">
27
  <td id="projectalign">
28
   <div id="projectname">LDClient<span id="projectnumber">&#160;v.1</span>
29
   </div>
30
   <div id="projectbrief">Client application for the detection of Lauterbach debugger devices</div>
31
  </td>
32
 </tr>
33
 </tbody>
34
</table>
35
</div>
36
<!-- end header part -->
37
<!-- Generated by Doxygen 1.9.4 -->
38
<script type="text/javascript">
39
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
40
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
41
/* @license-end */
42
</script>
43
<script type="text/javascript" src="menudata.js"></script>
44
<script type="text/javascript" src="menu.js"></script>
45
<script type="text/javascript">
46
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
47
$(function() {
48
  initMenu('',true,false,'search.php','Search');
49
  $(document).ready(function() { init_search(); });
50
});
51
/* @license-end */
52
</script>
53
<div id="main-nav"></div>
54
</div><!-- top -->
55
<div id="side-nav" class="ui-resizable side-nav-resizable">
56
  <div id="nav-tree">
57
    <div id="nav-tree-contents">
58
      <div id="nav-sync" class="sync"></div>
59
    </div>
60
  </div>
61
  <div id="splitbar" style="-moz-user-select:none;" 
62
       class="ui-resizable-handle">
63
  </div>
64
</div>
65
<script type="text/javascript">
66
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
67
$(document).ready(function(){initNavTree('class_l_d_client_1_1detection_1_1_info_fetcher.html',''); initResizable(); });
68
/* @license-end */
69
</script>
70
<div id="doc-content">
71
<!-- window showing the filter options -->
72
<div id="MSearchSelectWindow"
73
     onmouseover="return searchBox.OnSearchSelectShow()"
74
     onmouseout="return searchBox.OnSearchSelectHide()"
75
     onkeydown="return searchBox.OnSearchSelectKey(event)">
76
</div>
77

    
78
<!-- iframe showing the search results (closed by default) -->
79
<div id="MSearchResultsWindow">
80
<iframe src="javascript:void(0)" frameborder="0" 
81
        name="MSearchResults" id="MSearchResults">
82
</iframe>
83
</div>
84

    
85
<div class="header">
86
  <div class="summary">
87
<a href="#pub-methods">Public Member Functions</a> &#124;
88
<a href="#pub-attribs">Public Attributes</a> &#124;
89
<a href="#properties">Properties</a> &#124;
90
<a href="class_l_d_client_1_1detection_1_1_info_fetcher-members.html">List of all members</a>  </div>
91
  <div class="headertitle"><div class="title">LDClient.detection.InfoFetcher Class Reference</div></div>
92
</div><!--header-->
93
<div class="contents">
94

    
95
<p>This class implements the <a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html" title="This interface defines the functionality of an info fetcher which takes care of sending commands to t...">IInfoFetcher</a> interface which defines the functionality of an info fetcher.  
96
 <a href="class_l_d_client_1_1detection_1_1_info_fetcher.html#details">More...</a></p>
97
<table class="memberdecls">
98
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
99
Public Member Functions</h2></td></tr>
100
<tr class="memitem:abadca27b2740339ac6c1fd5c5e08bb26"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_d_client_1_1detection_1_1_info_fetcher.html#abadca27b2740339ac6c1fd5c5e08bb26">InfoFetcher</a> (uint maxAttempts, uint waitPeriodMs, string infoFilePath, string f32RemExecutable, string[] f32RemArguments, int f32SuccessExitCode, int f32WaitTimeoutMs)</td></tr>
101
<tr class="memdesc:abadca27b2740339ac6c1fd5c5e08bb26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an instance of this class.  <a href="class_l_d_client_1_1detection_1_1_info_fetcher.html#abadca27b2740339ac6c1fd5c5e08bb26">More...</a><br /></td></tr>
102
<tr class="separator:abadca27b2740339ac6c1fd5c5e08bb26"><td class="memSeparator" colspan="2">&#160;</td></tr>
103
<tr class="memitem:a2192ceaf45e724814bdfde96fc0e544c"><td class="memItemLeft" align="right" valign="top">async Task&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_d_client_1_1detection_1_1_info_fetcher.html#a2192ceaf45e724814bdfde96fc0e544c">FetchDataAsync</a> ()</td></tr>
104
<tr class="memdesc:a2192ceaf45e724814bdfde96fc0e544c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetches data from the debugger. It sends the commands defined in the appsettings.json file to the debugger and tries to parse the .txt (contains the serial numbers).  <a href="class_l_d_client_1_1detection_1_1_info_fetcher.html#a2192ceaf45e724814bdfde96fc0e544c">More...</a><br /></td></tr>
105
<tr class="separator:a2192ceaf45e724814bdfde96fc0e544c"><td class="memSeparator" colspan="2">&#160;</td></tr>
106
<tr class="memitem:a115b4d4fb74bd4eb09d8eeb4716793f9"><td class="memItemLeft" align="right" valign="top">Task&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#a115b4d4fb74bd4eb09d8eeb4716793f9">FetchDataAsync</a> ()</td></tr>
107
<tr class="memdesc:a115b4d4fb74bd4eb09d8eeb4716793f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fetches data from the debugger. It sends the commands defined in the appsettings.json file to the debugger and tries to parse the .txt (contains the serial numbers).  <a href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#a115b4d4fb74bd4eb09d8eeb4716793f9">More...</a><br /></td></tr>
108
<tr class="separator:a115b4d4fb74bd4eb09d8eeb4716793f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
109
</table><table class="memberdecls">
110
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
111
Public Attributes</h2></td></tr>
112
<tr class="memitem:a37f11db6d7bc81193b70015fc9192ed8"><td class="memItemLeft" align="right" valign="top"><a id="a37f11db6d7bc81193b70015fc9192ed8" name="a37f11db6d7bc81193b70015fc9192ed8"></a>
113
<a class="el" href="interface_l_d_client_1_1detection_1_1_i_process_utils.html">IProcessUtils</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ProcessUtils</b></td></tr>
114
<tr class="memdesc:a37f11db6d7bc81193b70015fc9192ed8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instance of <a class="el" href="class_l_d_client_1_1detection_1_1_process_utils.html" title="This class implements the IProcessUtils interface. It implements methods that are used when dealing w...">ProcessUtils</a> which encapsulates common functionality when it comes to dealing with processes (limited by the needs of this application). <br /></td></tr>
115
<tr class="separator:a37f11db6d7bc81193b70015fc9192ed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
116
<tr class="memitem:af30dbfb7559215ee29998f00ef5ea140"><td class="memItemLeft" align="right" valign="top"><a id="af30dbfb7559215ee29998f00ef5ea140" name="af30dbfb7559215ee29998f00ef5ea140"></a>
117
<a class="el" href="interface_l_d_client_1_1utils_1_1_i_file_utils.html">IFileUtils</a>&#160;</td><td class="memItemRight" valign="bottom"><b>FileUtils</b></td></tr>
118
<tr class="memdesc:af30dbfb7559215ee29998f00ef5ea140"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instance of FileUtils which encapsulates common functionality when it comes to dealing with files (limited by the needs of this application). <br /></td></tr>
119
<tr class="separator:af30dbfb7559215ee29998f00ef5ea140"><td class="memSeparator" colspan="2">&#160;</td></tr>
120
</table><table class="memberdecls">
121
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
122
Properties</h2></td></tr>
123
<tr class="memitem:a053ba7e01a8cfcbebf2325a864e98e2f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_d_client_1_1detection_1_1_info_fetcher.html#a053ba7e01a8cfcbebf2325a864e98e2f">HeadSerialNumber</a> = UndefinedSerialNumber<code> [get, set]</code></td></tr>
124
<tr class="memdesc:a053ba7e01a8cfcbebf2325a864e98e2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the head serial number of the debugger.  <a href="class_l_d_client_1_1detection_1_1_info_fetcher.html#a053ba7e01a8cfcbebf2325a864e98e2f">More...</a><br /></td></tr>
125
<tr class="separator:a053ba7e01a8cfcbebf2325a864e98e2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
126
<tr class="memitem:af38c5cdb5dc206c65d5f018e0b30dd1d"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_d_client_1_1detection_1_1_info_fetcher.html#af38c5cdb5dc206c65d5f018e0b30dd1d">BodySerialNumber</a> = UndefinedSerialNumber<code> [get, set]</code></td></tr>
127
<tr class="memdesc:af38c5cdb5dc206c65d5f018e0b30dd1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the body serial number of the debugger.  <a href="class_l_d_client_1_1detection_1_1_info_fetcher.html#af38c5cdb5dc206c65d5f018e0b30dd1d">More...</a><br /></td></tr>
128
<tr class="separator:af38c5cdb5dc206c65d5f018e0b30dd1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
129
<tr class="inherit_header properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html">LDClient.detection.IInfoFetcher</a></td></tr>
130
<tr class="memitem:a196620b51706ff95e86dce886bd3d3a0 inherit properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#a196620b51706ff95e86dce886bd3d3a0">HeadSerialNumber</a><code> [get, set]</code></td></tr>
131
<tr class="memdesc:a196620b51706ff95e86dce886bd3d3a0 inherit properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the head serial number of the debugger.  <a href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#a196620b51706ff95e86dce886bd3d3a0">More...</a><br /></td></tr>
132
<tr class="separator:a196620b51706ff95e86dce886bd3d3a0 inherit properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
133
<tr class="memitem:afff68b22c92585ba9169cd558bcb66b9 inherit properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#afff68b22c92585ba9169cd558bcb66b9">BodySerialNumber</a><code> [get, set]</code></td></tr>
134
<tr class="memdesc:afff68b22c92585ba9169cd558bcb66b9 inherit properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the body serial number of the debugger.  <a href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#afff68b22c92585ba9169cd558bcb66b9">More...</a><br /></td></tr>
135
<tr class="separator:afff68b22c92585ba9169cd558bcb66b9 inherit properties_interface_l_d_client_1_1detection_1_1_i_info_fetcher"><td class="memSeparator" colspan="2">&#160;</td></tr>
136
</table>
137
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
138
<div class="textblock"><p >This class implements the <a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html" title="This interface defines the functionality of an info fetcher which takes care of sending commands to t...">IInfoFetcher</a> interface which defines the functionality of an info fetcher. </p>
139
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
140
<a id="abadca27b2740339ac6c1fd5c5e08bb26" name="abadca27b2740339ac6c1fd5c5e08bb26"></a>
141
<h2 class="memtitle"><span class="permalink"><a href="#abadca27b2740339ac6c1fd5c5e08bb26">&#9670;&nbsp;</a></span>InfoFetcher()</h2>
142

    
143
<div class="memitem">
144
<div class="memproto">
145
      <table class="memname">
146
        <tr>
147
          <td class="memname">LDClient.detection.InfoFetcher.InfoFetcher </td>
148
          <td>(</td>
149
          <td class="paramtype">uint&#160;</td>
150
          <td class="paramname"><em>maxAttempts</em>, </td>
151
        </tr>
152
        <tr>
153
          <td class="paramkey"></td>
154
          <td></td>
155
          <td class="paramtype">uint&#160;</td>
156
          <td class="paramname"><em>waitPeriodMs</em>, </td>
157
        </tr>
158
        <tr>
159
          <td class="paramkey"></td>
160
          <td></td>
161
          <td class="paramtype">string&#160;</td>
162
          <td class="paramname"><em>infoFilePath</em>, </td>
163
        </tr>
164
        <tr>
165
          <td class="paramkey"></td>
166
          <td></td>
167
          <td class="paramtype">string&#160;</td>
168
          <td class="paramname"><em>f32RemExecutable</em>, </td>
169
        </tr>
170
        <tr>
171
          <td class="paramkey"></td>
172
          <td></td>
173
          <td class="paramtype">string[]&#160;</td>
174
          <td class="paramname"><em>f32RemArguments</em>, </td>
175
        </tr>
176
        <tr>
177
          <td class="paramkey"></td>
178
          <td></td>
179
          <td class="paramtype">int&#160;</td>
180
          <td class="paramname"><em>f32SuccessExitCode</em>, </td>
181
        </tr>
182
        <tr>
183
          <td class="paramkey"></td>
184
          <td></td>
185
          <td class="paramtype">int&#160;</td>
186
          <td class="paramname"><em>f32WaitTimeoutMs</em>&#160;</td>
187
        </tr>
188
        <tr>
189
          <td></td>
190
          <td>)</td>
191
          <td></td><td></td>
192
        </tr>
193
      </table>
194
</div><div class="memdoc">
195

    
196
<p>Creates an instance of this class. </p>
197
<dl class="params"><dt>Parameters</dt><dd>
198
  <table class="params">
199
    <tr><td class="paramname">maxAttempts</td><td>Maximum number of attempts to locate and parse the .txt file</td></tr>
200
    <tr><td class="paramname">waitPeriodMs</td><td>Period (how often) the application tries to locate and parse the .txt file</td></tr>
201
    <tr><td class="paramname">infoFilePath</td><td>Path to the .txt file which is generated from the debugger</td></tr>
202
    <tr><td class="paramname">f32RemExecutable</td><td>Path to the t32rem.exe file which is used to send commands to the debugger</td></tr>
203
    <tr><td class="paramname">f32RemArguments</td><td>Arguments (commands) sent to the debugger in order to generate a .txt file containing all the desired information.</td></tr>
204
    <tr><td class="paramname">f32SuccessExitCode</td><td>Status code indicating a successful termination of t32rem.exe</td></tr>
205
    <tr><td class="paramname">f32WaitTimeoutMs</td><td>Timeout used when waiting for the t32rem.exe to finish</td></tr>
206
  </table>
207
  </dd>
208
</dl>
209

    
210
</div>
211
</div>
212
<h2 class="groupheader">Member Function Documentation</h2>
213
<a id="a2192ceaf45e724814bdfde96fc0e544c" name="a2192ceaf45e724814bdfde96fc0e544c"></a>
214
<h2 class="memtitle"><span class="permalink"><a href="#a2192ceaf45e724814bdfde96fc0e544c">&#9670;&nbsp;</a></span>FetchDataAsync()</h2>
215

    
216
<div class="memitem">
217
<div class="memproto">
218
      <table class="memname">
219
        <tr>
220
          <td class="memname">async Task&lt; bool &gt; LDClient.detection.InfoFetcher.FetchDataAsync </td>
221
          <td>(</td>
222
          <td class="paramname"></td><td>)</td>
223
          <td></td>
224
        </tr>
225
      </table>
226
</div><div class="memdoc">
227

    
228
<p>Fetches data from the debugger. It sends the commands defined in the appsettings.json file to the debugger and tries to parse the .txt (contains the serial numbers). </p>
229
<dl class="section return"><dt>Returns</dt><dd>True, if data was fetched successfully. False otherwise.</dd></dl>
230

    
231
<p>Implements <a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#a115b4d4fb74bd4eb09d8eeb4716793f9">LDClient.detection.IInfoFetcher</a>.</p>
232

    
233
</div>
234
</div>
235
<h2 class="groupheader">Property Documentation</h2>
236
<a id="af38c5cdb5dc206c65d5f018e0b30dd1d" name="af38c5cdb5dc206c65d5f018e0b30dd1d"></a>
237
<h2 class="memtitle"><span class="permalink"><a href="#af38c5cdb5dc206c65d5f018e0b30dd1d">&#9670;&nbsp;</a></span>BodySerialNumber</h2>
238

    
239
<div class="memitem">
240
<div class="memproto">
241
<table class="mlabels">
242
  <tr>
243
  <td class="mlabels-left">
244
      <table class="memname">
245
        <tr>
246
          <td class="memname">string LDClient.detection.InfoFetcher.BodySerialNumber = UndefinedSerialNumber</td>
247
        </tr>
248
      </table>
249
  </td>
250
  <td class="mlabels-right">
251
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
252
  </tr>
253
</table>
254
</div><div class="memdoc">
255

    
256
<p>Returns the body serial number of the debugger. </p>
257

    
258
<p>Implements <a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#afff68b22c92585ba9169cd558bcb66b9">LDClient.detection.IInfoFetcher</a>.</p>
259

    
260
</div>
261
</div>
262
<a id="a053ba7e01a8cfcbebf2325a864e98e2f" name="a053ba7e01a8cfcbebf2325a864e98e2f"></a>
263
<h2 class="memtitle"><span class="permalink"><a href="#a053ba7e01a8cfcbebf2325a864e98e2f">&#9670;&nbsp;</a></span>HeadSerialNumber</h2>
264

    
265
<div class="memitem">
266
<div class="memproto">
267
<table class="mlabels">
268
  <tr>
269
  <td class="mlabels-left">
270
      <table class="memname">
271
        <tr>
272
          <td class="memname">string LDClient.detection.InfoFetcher.HeadSerialNumber = UndefinedSerialNumber</td>
273
        </tr>
274
      </table>
275
  </td>
276
  <td class="mlabels-right">
277
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
278
  </tr>
279
</table>
280
</div><div class="memdoc">
281

    
282
<p>Returns the head serial number of the debugger. </p>
283

    
284
<p>Implements <a class="el" href="interface_l_d_client_1_1detection_1_1_i_info_fetcher.html#a196620b51706ff95e86dce886bd3d3a0">LDClient.detection.IInfoFetcher</a>.</p>
285

    
286
</div>
287
</div>
288
<hr/>The documentation for this class was generated from the following file:<ul>
289
<li>detection/InfoFetcher.cs</li>
290
</ul>
291
</div><!-- contents -->
292
</div><!-- doc-content -->
293
<!-- start footer part -->
294
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
295
  <ul>
296
    <li class="navelem"><a class="el" href="namespace_l_d_client.html">LDClient</a></li><li class="navelem"><a class="el" href="namespace_l_d_client_1_1detection.html">detection</a></li><li class="navelem"><a class="el" href="class_l_d_client_1_1detection_1_1_info_fetcher.html">InfoFetcher</a></li>
297
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
298
  </ul>
299
</div>
300
</body>
301
</html>
(9-9/111)