SDK Home Glossary Index Left Right Up

Introduction to CComms OPX


Chapter Contents


Overview

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.


Status

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.

Much of the documentation has yet to be completed. Incompleted section are marked <TBS>. If you have access to the EPOC32 C++ documentation additional information (until this documentation has been completed) may be obtained from <TBS> .


Naming conventions

The names of the routines have been derived from the names of the methods in the C++ classes on which they are derived.

The names for routines which create (constructors) an object of type Class are of the form NewClass.

The name of the routine which destroys an objects of type Class is of the form DeleteClass.

The name of routines which perform actions on an objects of type Class is of the form ClassRoutineName.


Creating and using objects

In order to creat an object the relevant NewClass routine is called and a reference to the created object is returned.

this& = NewClass&:()

The returned value is then passed as the first parameter to all subsequent routines used to manipulate the object.

ClassMethod:(this&,....)

Before the program terminate the object must be destroyed by calling the DeleteClass routine.

DeleteClass:(this&)


  SDK Home Glossary Index Left Right Up