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
|
<!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.11"/>
<title>dashel: Dashel::SerialPortEnumerator Class 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="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">dashel
 <span id="projectnumber">1.3.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceDashel.html">Dashel</a></li><li class="navelem"><a class="el" href="classDashel_1_1SerialPortEnumerator.html">SerialPortEnumerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classDashel_1_1SerialPortEnumerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Dashel::SerialPortEnumerator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Serial port enumerator class.
<a href="classDashel_1_1SerialPortEnumerator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="dashel_8h_source.html">dashel.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1c11411907fb4773164a5f6f5ab74f14"><td class="memItemLeft" align="right" valign="top">static std::map< int, std::pair< std::string, std::string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classDashel_1_1SerialPortEnumerator.html#a1c11411907fb4773164a5f6f5ab74f14">getPorts</a> ()</td></tr>
<tr class="memdesc:a1c11411907fb4773164a5f6f5ab74f14"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve list of all serial ports available on system. <a href="#a1c11411907fb4773164a5f6f5ab74f14">More...</a><br /></td></tr>
<tr class="separator:a1c11411907fb4773164a5f6f5ab74f14"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Serial port enumerator class. </p>
<p>This class is just a package for one static method. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1c11411907fb4773164a5f6f5ab74f14"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::map<int, std::pair<std::string, std::string> > Dashel::SerialPortEnumerator::getPorts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve list of all serial ports available on system. </p>
<p>This function queries the Operating System for all available serial ports. </p><dl class="section return"><dt>Returns</dt><dd>A map where the key is the port number name as passed to the ser: protocol, and the value is a pair of the system device name and a human readable description that may be displayed in a user interface. All strings are encoded in UTF-8. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>dashel/<a class="el" href="dashel_8h_source.html">dashel.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|
