vtkPlusGenericSerialDevice.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 __vtkPlusGenericSerialDevice_h
#define __vtkPlusGenericSerialDevice_h

#include "vtkPlusDataCollectionExport.h"

#include "vtkPlusDevice.h"

class SerialLine;

class vtkPlusDataCollectionExport vtkPlusGenericSerialDevice : public vtkPlusDevice
{
public:

  static vtkPlusGenericSerialDevice* New();
  vtkTypeMacro(vtkPlusGenericSerialDevice, vtkPlusDevice);
  void PrintSelf(ostream& os, vtkIndent indent);

  static const char* SERIAL_COMMAND_GET_RTS;
  static const char* SERIAL_COMMAND_SET_RTS;
  static const char* SERIAL_COMMAND_GET_CTS;

  PlusStatus InternalConnect();

  virtual PlusStatus InternalDisconnect();

  PlusStatus InternalUpdate();

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* config);

  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* config);

  virtual bool IsTracker() const { return false; }

  vtkSetMacro(SerialPort, unsigned long);
  vtkSetMacro(BaudRate, unsigned long);
  vtkSetMacro(MaximumReplyDelaySec, double);
  vtkSetMacro(MaximumReplyDurationSec, double);

  void SetLineEnding(const char* lineEndingHex);
  vtkGetMacro(LineEnding, std::string);

  enum ReplyTermination
  {
    REQUIRE_LINE_ENDING = 0, // only proper LineEnding termination will result in success
    REQUIRE_NOT_EMPTY = 1, // if respnse is not empty, results in success even on timeout
    ANY = 2 // always results in success, but waits for a timeout or LineEnding termination
  };

  virtual PlusStatus SendText(const std::string& textToSend, std::string* textReceived = NULL) VTK_OVERRIDE { return this->SendText(textToSend, textReceived, REQUIRE_LINE_ENDING); };
  virtual PlusStatus SendText(const std::string& textToSend, std::string* textReceived, ReplyTermination acceptReply);

  virtual PlusStatus ReceiveResponse(std::string& textReceived, ReplyTermination acceptReply = REQUIRE_LINE_ENDING);

  virtual PlusStatus NotifyConfigured();

  PlusStatus SetDTR(bool onOff);

  vtkGetMacro(DTR, bool);

  PlusStatus SetRTS(bool onOff);

  vtkGetMacro(RTS, bool);

  PlusStatus GetDSR(bool& onOff);

  PlusStatus GetCTS(bool& onOff);

protected:
  vtkPlusGenericSerialDevice();
  ~vtkPlusGenericSerialDevice();

  virtual bool WaitForResponse();

private:
  vtkPlusGenericSerialDevice(const vtkPlusGenericSerialDevice&);
  void operator=(const vtkPlusGenericSerialDevice&);

protected:
  SerialLine* Serial;

  unsigned long SerialPort;

  unsigned long BaudRate;

  bool DTR;

  bool RTS;

  std::string LineEnding;

  std::string LineEndingBin;

  double MaximumReplyDelaySec;

  double MaximumReplyDurationSec;

  long FrameNumber;
  vtkPlusDataSource* FieldDataSource;

  vtkSmartPointer<vtkIGSIORecursiveCriticalSection> Mutex;
};

#endif