/****************************************************************************/
/* Copyright (c) 2000 MBARI                                                 */
/* MBARI Proprietary Information. All rights reserved.                      */
/****************************************************************************/
/* Summary  :                                                               */
/* Filename : PolledSerialDriver.h                                          */
/* Author   :                                                               */
/* Project  :                                                               */
/* Version  : 1.0                                                           */
/* Created  : 02/07/2000                                                    */
/* Modified :                                                               */
/* Archived :                                                               */
/****************************************************************************/
/* Modification History:                                                    */
/****************************************************************************/
#ifndef _POLLEDSERIALDRIVER_H
#define _POLLEDSERIALDRIVER_H

#include "PeriodicTask.h"

/*
CLASS 
PolledSerialDriver

DESCRIPTION
Base class for polled serial device drivers

AUTHOR
Tom O'Reilly
*/

class PolledSerialDriver : public PeriodicTask {

public:

  ////////////////////////////////////////////////////////////////////
  // Constructor
  // [input] name: Driver name
  // [input] serialDevice: Associated SerialDevice
  // [input] pollPeriodMillisec: Period at which device is polled
  PolledSerialDriver(const char *name, 
		     SerialDevice *serialDevice, 
		     unsigned pollPeriodMillisec);

  ////////////////////////////////////////////////////////////////////
  // Destructor
  ~PolledSerialDriver();

  ////////////////////////////////////////////////////////////////////
  // Driver name
  const char *name();

  ////////////////////////////////////////////////////////////////////
  // Polling period in millisec
  unsigned pollPeriod();

  ////////////////////////////////////////////////////////////////////
  // Set polling timeout in millisec
  void setPollTimeout(unsigned timeout);

  ////////////////////////////////////////////////////////////////////
  // Initialize device
  virtual void initialize() = 0;

  ////////////////////////////////////////////////////////////////////
  // Read device data
  virtual void readData() = 0;


protected:

  ////////////////////////////////////////////////////////////////////
  // Polling timeout in millisec
  unsigned pollTimeout();

  SerialDevice *_serialDevice;

private:

  // Polling period in millisec
  unsigned _pollPeriod;

  // Polling timeout in millisec
  unsigned _pollTimeout;

  const char *_name;
};


#endif