comm_drv_registry.h

/***************************************************************************
 *
 * Project:  OpenCPN
 * Purpose:  Driver registration container, a singleton.
 * Author:   David Register, Alec Leamas
 *
 ***************************************************************************
 *   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 _COMMDRIVERREGISTRY_H__
#define _COMMDRIVERREGISTRY_H__
 
#include "comm_driver.h"
#include "observable_evtvar.h"
 
class ConnectionParams;
 
typedef std::shared_ptr<AbstractCommDriver> DriverPtr;
 
class CommDriverRegistry final {
public:
  static CommDriverRegistry& GetInstance();
 
  void Activate(DriverPtr driver);
 
  void Deactivate(DriverPtr driver);
 
  void CloseAllDrivers();
 
  const std::vector<DriverPtr>& GetDrivers();
 
 
  // FIXME (Dave)
  //  Stub method, to pretest drivers.
  //  Goes away for production
  void TestDriver(ConnectionParams* params);
 
  EventVar evt_driverlist_change;
 
  EventVar evt_driver_msg;
 
private:
  CommDriverRegistry()  = default;
  CommDriverRegistry(const CommDriverRegistry&) = delete;
  CommDriverRegistry& operator=(const CommDriverRegistry&) = delete;
 
  std::vector<DriverPtr> drivers;
};
 
const DriverPtr FindDriver(const std::vector<DriverPtr>& drivers,
                           const std::string& iface,
                           const NavAddr::Bus _bus = NavAddr::Bus::Undef);
 
#endif  // guard