<!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><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>
<div class="contents">
<h1>FlexiPort<br/>
<small>
[<a class="el" href="group__gbx__libs.html">Libraries</a>, <a class="el" href="group__gbx__cpp.html">C++</a>, <a class="el" href="group__gbx__linux.html">Linux</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>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflexiport.html">flexiport</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>FlexiPort data communications library. </p>
<br/></td></tr>
</p>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>FlexiPort data communications library. </p>
<p>Provides a consistent interface for communicating over a range of data port types. Currently serial and TCP ports are supported. Support for USB ports is planned for when I get a suitable USB device to test with. Logging is possible, which allows communications sessions to be played back at a later date without the original hardware present.</p>
<p>The SerialPort and TCPPort port types are cross-platform, usable on Linux, Mac OSX and Microsoft Windows. If this library is compiled as static on Windows, you must define the <code>FLEXIPORT_STATIC</code> preprocessor variable when compiling code that includes <a class="el" href="port_8h_source.html">port.h</a>, <a class="el" href="flexiport_8h_source.html">flexiport.h</a> or <a class="el" href="timeout_8h_source.html">timeout.h</a>.</p>
<p>For a full list of classes and functions, see <a class="el" href="namespaceflexiport.html">flexiport</a>.</p>
<dl class="user"><dt><b>Header file</b></dt><dd></dd></dl>
<p>Necessary: </p>
<div class="fragment"><pre class="fragment">
#include <flexiport/flexiport.h>
#include <flexiport/port.h>
</pre></div><p>Optional if port type-specific features are required: For SerialPort: </p>
<div class="fragment"><pre class="fragment">
#include <flexiport/serialport.h>
</pre></div><p> For TCPPort: </p>
<div class="fragment"><pre class="fragment">
#include <flexiport/tcpport.h>
</pre></div><p> For logging ports: </p>
<div class="fragment"><pre class="fragment">
#include <flexiport/logwriterport.h>
#include <flexiport/logreaderport.h>
</pre></div><dl class="user"><dt><b>Example</b></dt><dd>See test/tcp_example.cpp and test/serial_example.cpp.</dd></dl>
<dl class="user"><dt><b>Style</b></dt><dd><ul>
<li>Naming conventions:<ul>
<li>Class methods start with a capital letter.</li>
<li>variableNamesLikeThis.</li>
<li>Private member variables start with an underscore _like _this.</li>
<li>Avoid using #defines. #define'd values in all capitals when necessary.</li>
</ul>
</li>
<li>Formatting:<ul>
<li>1 tab indentation at start of lines, spaces only for inside lines (e.g. before commands).</li>
<li>Function declarations on one line.</li>
<li>Space between function name and arguments.</li>
</ul>
</li>
<li>C++ API.<ul>
<li>Functionality provided through classes.</li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="user"><dt><b>Copyright</b></dt><dd>Geoffrey Biggs</dd></dl>
<dl class="user"><dt><b>Responsible Developer</b></dt><dd>Geoffrey Biggs</dd></dl>
<dl class="user"><dt><b>License</b></dt><dd>LGPL</dd></dl>
<dl class="user"><dt><b>Dependencies</b></dt><dd></dd></dl>
<ul>
<li>None </li>
</ul>
</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>
