OpenCPN Partial API docs
comm_drv_n2k.h
1 /***************************************************************************
2  *
3  * Project: OpenCPN
4  * Purpose:
5  * Author: David Register, Alec Leamas
6  *
7  ***************************************************************************
8  * Copyright (C) 2022 by David Register, Alec Leamas *
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  * This program is distributed in the hope that it will be useful, *
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18  * GNU General Public License for more details. *
19  * *
20  * You should have received a copy of the GNU General Public License *
21  * along with this program; if not, write to the *
22  * Free Software Foundation, Inc., *
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
24  **************************************************************************/
25 #ifndef _COMMDRIVERN2K_H__
26 #define _COMMDRIVERN2K_H__
27 
28 #include <memory>
29 
30 #include "model/comm_driver.h"
31 
33 public:
34  CommDriverN2K(const std::string& s = "n2k0" );
35 
36  virtual ~CommDriverN2K();
37 
38  virtual bool SendMessage(std::shared_ptr<const NavMsg> msg,
39  std::shared_ptr<const NavAddr> addr) override = 0;
40  virtual void SetListener(DriverListener& l) override;
41  virtual std::shared_ptr<NavAddr> GetAddress(const N2kName& name);
42  virtual int SetTXPGN(int pgn){ return 0; }
43 };
44 
45 #endif // guard
Common interface for all drivers.
Definition: comm_driver.h:58
virtual void SetListener(DriverListener &l) override
Set the entity which will receive incoming data.
Interface implemented by transport layer and possible other parties like test code which should handl...
Definition: comm_driver.h:47
N2k uses CAN which defines the basic properties of messages.
Definition: comm_navmsg.h:59