<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>flexiport Namespace Reference<br/>
<small>
[<a class="el" href="group__gbx__library__flexiport.html">FlexiPort</a>]</small>
</h1>
<p>FlexiPort data communications library.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1PortException.html">PortException</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exception thrown by the <a class="el" href="classflexiport_1_1Port.html" title="Base Port class.">Port</a> class and its derivatives. <a href="classflexiport_1_1PortException.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1LogReaderPort.html">LogReaderPort</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simulated port using a log file. <a href="classflexiport_1_1LogReaderPort.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1LogWriterPort.html">LogWriterPort</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Logging implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class. An underlying <a class="el" href="classflexiport_1_1Port.html" title="Base Port class.">Port</a> object is used to perform the actual communications. All actions taken by that port are logged, including data transferred. The log file can be used with a <a class="el" href="classflexiport_1_1LogReaderPort.html" title="Simulated port using a log file.">LogReaderPort</a> to simulate a <a class="el" href="classflexiport_1_1Port.html" title="Base Port class.">Port</a> object and perform testing. <a href="classflexiport_1_1LogWriterPort.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1Port.html">Port</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base <a class="el" href="classflexiport_1_1Port.html" title="Base Port class.">Port</a> class. <a href="classflexiport_1_1Port.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html">SerialPort</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serial implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class. <a href="classflexiport_1_1SerialPort.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html">TCPPort</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">TCP implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class. <a href="classflexiport_1_1TCPPort.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1Timeout.html">Timeout</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An object used to represent timeouts. <a href="classflexiport_1_1Timeout.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1UDPPort.html">UDPPort</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">UDP implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class. This class provides UDP communication between two known end points. It cannot send to any address other than the configured address. <a href="classflexiport_1_1UDPPort.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLEXIPORT_EXPORT <a class="el" href="classflexiport_1_1Port.html">Port</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflexiport.html#aa3d58772ad935e45ee1c20da8af32995">CreatePort</a> (std::map< std::string, std::string > options)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Factory function to create a <a class="el" href="classflexiport_1_1Port.html">Port</a> object of the necessary port type. <a href="#aa3d58772ad935e45ee1c20da8af32995"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLEXIPORT_EXPORT <a class="el" href="classflexiport_1_1Port.html">Port</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflexiport.html#a30c3b9b978c582231bf374fd1d70fb43">CreatePort</a> (std::string options)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Overloaded factory function. Accepts options as a string. <a href="#a30c3b9b978c582231bf374fd1d70fb43"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>FlexiPort data communications library. </p>
<p>This namespace is part of the FlexiPort library.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__gbx__library__flexiport.html">FlexiPort</a> </dd></dl>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a30c3b9b978c582231bf374fd1d70fb43"></a><!-- doxytag: member="flexiport::CreatePort" ref="a30c3b9b978c582231bf374fd1d70fb43" args="(std::string options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLEXIPORT_EXPORT <a class="el" href="classflexiport_1_1Port.html">Port</a>* flexiport::CreatePort </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>options</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Overloaded factory function. Accepts options as a string. </p>
<p>This overload accepts the options as a string. For example: "type=serial device=/dev/ttyS0 baud=4800 readwrite" Options may be separated by any of: spaces, tabs, new lines or commas. Do not put whitespace around an equals sign.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a <a class="el" href="classflexiport_1_1Port.html">Port</a> object. </dd></dl>
</div>
</div>
<a class="anchor" id="aa3d58772ad935e45ee1c20da8af32995"></a><!-- doxytag: member="flexiport::CreatePort" ref="aa3d58772ad935e45ee1c20da8af32995" args="(std::map< std::string, std::string > options)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLEXIPORT_EXPORT <a class="el" href="classflexiport_1_1Port.html">Port</a>* flexiport::CreatePort </td>
<td>(</td>
<td class="paramtype">std::map< std::string, std::string > </td>
<td class="paramname"> <em>options</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Factory function to create a <a class="el" href="classflexiport_1_1Port.html">Port</a> object of the necessary port type. </p>
<p>This factory function is the only way to create a <a class="el" href="classflexiport_1_1Port.html">Port</a> object matching the type of port you need. Options are passed in as key/value pairs in the options argument. A minimum of one option is necessary, the "type" option. This specifies the type of port to be created. An object of the correct class (<a class="el" href="classflexiport_1_1SerialPort.html">SerialPort</a>, <a class="el" href="classflexiport_1_1TCPPort.html">TCPPort</a> or <a class="el" href="classflexiport_1_1LogReaderPort.html">LogReaderPort</a>, for example) will be created based on the value of this option. All other options, including both universal options and type-specific options, will be passed on to the created object.</p>
<p>See Options for a list of options accepted by all port types. See each port type's description for a list of options accepted by that port type.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a <a class="el" href="classflexiport_1_1Port.html">Port</a> object. </dd></dl>
</div>
</div>
</div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
