PlusSerialLine.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
Program: Plus
Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
See License.txt for details.
=========================================================Plus=header=end*/


#ifndef _RAWSERIALLINE_H_
#define _RAWSERIALLINE_H_

#ifdef _WIN32
  #include <windows.h>
#else
  #define INVALID_HANDLE_VALUE (-1)
#endif

#include <string>

class SerialLine
{
public:
  typedef unsigned long DWORD;
  typedef unsigned int UINT;
  typedef unsigned char BYTE;

#ifdef _WIN32
  // HANDLE is defined for Windows already
#else
  typedef int HANDLE;
#endif

  SerialLine();
  virtual ~SerialLine();

  bool Open();

  void Close();

  int Write(const BYTE* data, int numberOfBytesToWrite);

  bool Write(const BYTE data);

  int Read(BYTE* data, int maxNumberOfBytesToRead);

  bool Read(BYTE& data);

  SetStdStringMacro(PortName);
  GetStdStringMacro(PortName);

  void SetSerialPortSpeed(DWORD speed);

  void SetMaxReplyTime(int maxreply);

  int GetMaxReplyTime() const;

  bool IsHandleAlive() const;

  unsigned int GetNumberOfBytesAvailableForReading() const;

  PlusStatus SetDTR(bool onOff);

  PlusStatus SetRTS(bool onOff);

  PlusStatus GetDSR(bool& onOff);

  PlusStatus GetCTS(bool& onOff);

  DWORD ClearError();

private:
  HANDLE      CommHandle;
  std::string PortName;
  DWORD       SerialPortSpeed;
  int         MaxReplyTime;
};

#endif