BasicReader Class Reference

Reader base class. More...

#include <BasicReader.h>

Inheritance diagram for BasicReader:
BarcodeReader RfidReader

List of all members.

Public Member Functions

virtual bool initialize ()
 Reader initialization routine.
virtual void shutdown ()
 Reader shutdown routine.
virtual void initRead ()
 Prepare for reading.
virtual void startRead ()
 Start reading.
virtual void stopRead ()
 Stop reading.

Detailed Description

Reader base class.

Implements reader basic functionality and provides interface for reader initialization and control. All system readers are inheriting this class.

Every reader must be initialized before the reader will be functional. The reader can be activated before the reading. The reading process can be started and stopped separately.


Member Function Documentation

bool BasicReader::initialize (  )  [virtual]

Reader initialization routine.

Reader implementation should override this function to implement a hardware initialization procedure. Reader manager calls this function during system initialization.

Returns:
Returns true if initialization was successful.

Reimplemented in BarcodeReader, and RfidReader.

void BasicReader::initRead (  )  [virtual]

Prepare for reading.

Reader implementation should override this function to prepare the reader hardware for data acquisition before an actual read occurs. This function is called by the reader manager when user initiates reading.

Read initialization is separated from the actual read to allow two-stage triggering, for example to enable for reader aiming.

A typical successful read is followed by the startRead() call and terminated by the stopRead() call.

Reimplemented in BarcodeReader, and RfidReader.

void BasicReader::shutdown (  )  [virtual]

Reader shutdown routine.

Reader implementation should override this function to implement a hardware de-initialization procedure. Reader manager calls this function during system shutdown.

Reimplemented in BarcodeReader, and RfidReader.

void BasicReader::startRead (  )  [virtual]

Start reading.

Reader implementation should override this function to start capturing data from the reader hardware . This function is called by the reader manager when user triggers reading.

A typical successful read is terminated by the stopRead() call.

Reimplemented in BarcodeReader, and RfidReader.

void BasicReader::stopRead (  )  [virtual]

Stop reading.

Reader implementation should override this function to stop capturing data from the reader hardware. This function is called by the reader manager when user detriggers reading or a reader timeout occurs.

Reimplemented in BarcodeReader, and RfidReader.


The documentation for this class was generated from the following files:
Generated on Wed Oct 20 11:13:43 2010 for libspatha by  doxygen 1.6.3