159 lines
6.0 KiB
HTML
159 lines
6.0 KiB
HTML
|
<html>
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type"
|
||
|
|
content="text/html; charset=iso-8859-1">
|
||
|
|
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
|
||
|
|
<title>Introduction</title>
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||
|
|
<tr>
|
||
|
|
<td width="400" height="40"> </td>
|
||
|
|
<td width="30" height="40"><a
|
||
|
|
href="../../../epoc32/doc/group/sdk.html"><img
|
||
|
|
src="../../../epoc32/doc/group/library.gif"
|
||
|
|
alt="SDK Home" align="top" border="0" width="30"
|
||
|
|
height="30"></a></td>
|
||
|
|
<td width="30" height="40"><a
|
||
|
|
href="../../../epoc32/doc/glossary/glossary.html"><img
|
||
|
|
src="../../../epoc32/doc/group/glossary.gif"
|
||
|
|
alt="Glossary" align="top" border="0" width="30"
|
||
|
|
height="30"></a></td>
|
||
|
|
<td width="30" height="40"><a
|
||
|
|
href="../../../epoc32/doc/index/id-toc.html"><img
|
||
|
|
src="../../../epoc32/doc/group/index.gif" alt="Index"
|
||
|
|
align="top" border="0" width="30" height="30"></a></td>
|
||
|
|
<td width="30" height="40"><a href="des-toc.htm"><b><img
|
||
|
|
src="../../../epoc32/doc/group/stoneleft.gif" alt="Left"
|
||
|
|
align="top" border="0" width="30" height="30"></b></a></td>
|
||
|
|
<td width="30" height="40"><a href="installa.htm"><b><img
|
||
|
|
src="../../../epoc32/doc/group/stoneright.gif"
|
||
|
|
alt="Right" align="top" border="0" width="30" height="30"></b></a></td>
|
||
|
|
<td width="30" height="40"><a href="des-toc.htm"><b><img
|
||
|
|
src="../../../epoc32/doc/group/stoneup.gif" alt="Up"
|
||
|
|
align="top" border="0" width="30" height="30"></b></a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h1>Introduction to CComms OPX</h1>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2>Chapter Contents</h2>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="#Overview"><strong>Overview</strong></a></li>
|
||
|
|
<li><a href="#Status"><strong>Status</strong></a></li>
|
||
|
|
<li><a href="#Naming Conventions"><strong>Naming conventions</strong></a></li>
|
||
|
|
<li><a href="#Creating and using objects"><strong>Creating
|
||
|
|
and using objects</strong></a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2><a name="Overview">Overview</a></h2>
|
||
|
|
|
||
|
|
<p>The CComms OPX is a thin interface layer which allows the
|
||
|
|
creation and manipulation of objects which are defined by the C++
|
||
|
|
classes which allow access to serial communications.</p>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2><a name="Status">Status</a></h2>
|
||
|
|
|
||
|
|
<p>This is the first official release of the OPX. Prior to this
|
||
|
|
the OPX was available in it's development version and has
|
||
|
|
therefore had most problems have hopefully been identified and
|
||
|
|
fixed.</p>
|
||
|
|
|
||
|
|
<p>Much of the documentation has yet to be completed. Incompleted
|
||
|
|
section are marked <font color="#FF0000"><TBS></font>. If
|
||
|
|
you have access to the EPOC32 C++ documentation additional
|
||
|
|
information (until this documentation has been completed) may be
|
||
|
|
obtained from <font color="#FF0000"><TBS></font> .</p>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2><a name="Naming Conventions">Naming conventions</a></h2>
|
||
|
|
|
||
|
|
<p>The names of the routines have been derived from the names of
|
||
|
|
the methods in the C++ classes on which they are derived.</p>
|
||
|
|
|
||
|
|
<p>The names for routines which create (constructors) an object
|
||
|
|
of type <em>Class</em> are of the form <strong>New</strong><em>Class</em>.</p>
|
||
|
|
|
||
|
|
<p>The name of the routine which destroys an objects of type <em>Class</em>
|
||
|
|
is of the form <strong>Delete</strong><em>Class</em>.</p>
|
||
|
|
|
||
|
|
<p>The name of routines which perform actions on an objects of
|
||
|
|
type <em>Class</em> is of the form <em>Class</em>RoutineName.</p>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<h2><a name="Creating and using objects">Creating and using
|
||
|
|
objects</a></h2>
|
||
|
|
|
||
|
|
<p>In order to creat an object the relevant <strong>New</strong><em>Class</em>
|
||
|
|
routine is called and a reference to the created object is
|
||
|
|
returned.</p>
|
||
|
|
|
||
|
|
<p align="center"><code>this& = NewClass&:()</code></p>
|
||
|
|
|
||
|
|
<p>The returned value is then passed as the first parameter to
|
||
|
|
all subsequent routines used to manipulate the object.</p>
|
||
|
|
|
||
|
|
<p align="center"><code>ClassMethod:(this&,....)</code></p>
|
||
|
|
|
||
|
|
<p>Before the program terminate the object must be destroyed by
|
||
|
|
calling the <strong>Delete</strong><em>Class</em> routine.</p>
|
||
|
|
|
||
|
|
<p align="center"><code>DeleteClass:(this&)</code></p>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||
|
|
<tr>
|
||
|
|
<td><table border="0" cellpadding="0" cellspacing="0"
|
||
|
|
width="100%">
|
||
|
|
<tr>
|
||
|
|
<td width="400" height="40"> </td>
|
||
|
|
<td width="30" height="40"><a
|
||
|
|
href="../../../epoc32/doc/group/sdk.html"><img
|
||
|
|
src="../../../epoc32/doc/group/library.gif"
|
||
|
|
alt="SDK Home" align="top" border="0" width="30"
|
||
|
|
height="30"></a></td>
|
||
|
|
<td width="30" height="40"><a
|
||
|
|
href="../../../epoc32/doc/glossary/glossary.html"><img
|
||
|
|
src="../../../epoc32/doc/group/glossary.gif"
|
||
|
|
alt="Glossary" align="top" border="0" width="30"
|
||
|
|
height="30"></a></td>
|
||
|
|
<td width="30" height="40"><a
|
||
|
|
href="../../../epoc32/doc/index/id-toc.html"><img
|
||
|
|
src="../../../epoc32/doc/group/index.gif"
|
||
|
|
alt="Index" align="top" border="0" width="30"
|
||
|
|
height="30"></a></td>
|
||
|
|
<td width="30" height="40"><a href="des-toc.htm"><b><img
|
||
|
|
src="../../../epoc32/doc/group/stoneleft.gif"
|
||
|
|
alt="Left" align="top" border="0" width="30"
|
||
|
|
height="30"></b></a></td>
|
||
|
|
<td width="30" height="40"><a href="installa.htm"><b><img
|
||
|
|
src="../../../epoc32/doc/group/stoneright.gif"
|
||
|
|
alt="Right" align="top" border="0" width="30"
|
||
|
|
height="30"></b></a></td>
|
||
|
|
<td width="30" height="40"><a href="des-toc.htm"><b><img
|
||
|
|
src="../../../epoc32/doc/group/stoneup.gif"
|
||
|
|
alt="Up" align="top" border="0" width="30"
|
||
|
|
height="30"></b></a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|