comm_drv_n0183_serial.h

Go to the documentation of this file.

 /**************************************************************************
 *   Copyright (C) 2022 by David Register, Alec Leamas                     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 **************************************************************************/
 
#ifndef _COMMDRIVERN0183SERIAL_H
#define _COMMDRIVERN0183SERIAL_H
 
#include <atomic>
#include <string>
 
#include <wx/event.h>
 
#include "model/comm_drv_n0183.h"
#include "model/comm_out_queue.h"
#include "model/conn_params.h"
#include "model/garmin_protocol_mgr.h"
 
class CommDriverN0183SerialThread;  // Internal
 
class CommDriverN0183SerialEvent : public wxEvent {
public:
  CommDriverN0183SerialEvent( wxEventType commandType, int id);
  ~CommDriverN0183SerialEvent();
 
  // accessors
  void SetPayload(std::shared_ptr<std::vector<unsigned char>> data);
  std::shared_ptr<std::vector<unsigned char>> GetPayload();
 
  // required for sending with wxPostEvent()
  wxEvent* Clone() const;
private:
  std::shared_ptr<std::vector<unsigned char>> m_payload;
};
 
wxDECLARE_EVENT(wxEVT_COMMDRIVER_N0183_SERIAL, CommDriverN0183SerialEvent);
 
 
class CommDriverN0183Serial : public CommDriverN0183, public wxEvtHandler {
public:
  CommDriverN0183Serial(const ConnectionParams* params, DriverListener& l);
 
  virtual ~CommDriverN0183Serial();
 
  void Activate() override;
 
  bool Open();
  void Close();
 
  //    Secondary thread life toggle
  //    Used to inform launching object (this) to determine if the thread can
  //    be safely called or polled, e.g. wxThread->Destroy();
  void SetSecThreadActive(void) { m_sec_thread_active = true; }
  void SetSecThreadInActive(void) { m_sec_thread_active = false; }
  bool IsSecThreadActive() const { return m_sec_thread_active; }
 
  bool IsGarminThreadActive();
  void StopGarminUSBIOThread(bool bPause);
 
  void SetSecondaryThread(CommDriverN0183SerialThread* secondary_Thread) {
    m_secondary_thread = secondary_Thread;
  }
  CommDriverN0183SerialThread* GetSecondaryThread() {
    return m_secondary_thread;
  }
  void SetThreadRunFlag(int run) { m_Thread_run_flag = run; }
 
  std::atomic_int m_Thread_run_flag;
 
  ConnectionParams GetParams() const { return m_params; }
 
  bool SendMessage(std::shared_ptr<const NavMsg> msg,
                   std::shared_ptr<const NavAddr> addr) override;
 
private:
  bool m_ok;
  std::string m_portstring;
  std::string m_baudrate;
  int m_handshake;
 
  CommDriverN0183SerialThread* m_secondary_thread;
  bool m_sec_thread_active;
 
  GarminProtocolHandler * m_garmin_handler;
 
  ConnectionParams m_params;
  DriverListener& m_listener;
 
  std::unique_ptr<CommOutQueue> m_out_queue;
 
  void handle_N0183_MSG(CommDriverN0183SerialEvent& event);
};
 
#endif  // guard