mitkSerialCommunication.h

Go to the documentation of this file.

/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

=========================================================================*/


#ifndef MITKSERIALCOMMUNICATION_H_HEADER_INCLUDED_
#define MITKSERIALCOMMUNICATION_H_HEADER_INCLUDED_

#include <MitkIGTExports.h>
#include "mitkCommon.h"
#include <itkObject.h>
#include <itkObjectFactory.h>

#ifdef WIN32
  #include <windows.h>
#else // Posix
  #include <termios.h>
#endif

namespace mitk
{

  class MitkIGT_EXPORT SerialCommunication : public itk::Object
  {
  public:
    mitkClassMacro(SerialCommunication, itk::Object);
    itkNewMacro(Self);

    enum PortNumber
    {
      COM1 = 1,
      COM2 = 2,
      COM3 = 3,
      COM4 = 4,
      COM5 = 5,
      COM6 = 6,
      COM7 = 7,
      COM8 = 8,
      COM9 = 9
    };

    enum BaudRate
    {
      BaudRate9600   = 9600,
      BaudRate14400  = 14400,
      BaudRate19200  = 19200,
      BaudRate38400  = 38400,
      BaudRate57600  = 57600,
      BaudRate115200 = 115200
    };

    enum DataBits
    {
      DataBits8 = 8,
      DataBits7 = 7
    };

    enum Parity
    {
      None = 'N',
      Odd  = 'O',
      Even = 'E'
    };

    enum StopBits
    {
      StopBits1 = 1,
      StopBits2 = 2
    };

    enum HardwareHandshake
    {
      HardwareHandshakeOn = 1,
      HardwareHandshakeOff = 0
    };

    int OpenConnection();
    void CloseConnection();

    int Receive(std::string& answer, unsigned int numberOfBytes);
    int Send(const std::string& input);

    void SendBreak(unsigned int ms = 400);

    void ClearReceiveBuffer();

    void ClearSendBuffer();

    itkGetConstMacro(PortNumber, PortNumber);

    itkSetMacro(PortNumber, PortNumber);

    itkGetStringMacro(DeviceName);

    itkSetStringMacro(DeviceName);

    itkGetConstMacro(BaudRate, BaudRate);

    itkSetMacro(BaudRate, BaudRate);

    itkGetConstMacro(DataBits, DataBits);

    itkSetMacro(DataBits, DataBits);

    itkGetConstMacro(Parity, Parity);

    itkSetMacro(Parity, Parity);

    itkGetConstMacro(StopBits, StopBits);

    itkSetMacro(StopBits, StopBits);

    itkGetConstMacro(HardwareHandshake, HardwareHandshake);

    itkSetMacro(HardwareHandshake, HardwareHandshake);

    itkGetConstMacro(SendTimeout, unsigned int);

    itkSetMacro(SendTimeout, unsigned int);

    itkGetConstMacro(ReceiveTimeout, unsigned int);

    itkSetMacro(ReceiveTimeout, unsigned int);

  protected:
    SerialCommunication();
    virtual ~SerialCommunication();

    int ApplyConfiguration();

    std::string m_DeviceName; 
    PortNumber m_PortNumber;  
    BaudRate m_BaudRate;      
    DataBits m_DataBits;      
    Parity m_Parity;          
    StopBits m_StopBits;      
    HardwareHandshake m_HardwareHandshake;  
    unsigned int m_ReceiveTimeout; 
    unsigned int m_SendTimeout;    

    bool m_Connected;       

  #ifdef WIN32
    HANDLE m_ComPortHandle;
    DWORD m_PreviousMask;
    COMMTIMEOUTS m_PreviousTimeout;
    DCB m_PreviousDeviceControlBlock;
  #else
    int m_FileDescriptor;
  #endif
  };

} // namespace mitk
#endif /* MITKSERIALCOMMUNICATION_H_HEADER_INCLUDED_ */