OpenCPN Partial API docs
comm_drv_file.h
1 /***************************************************************************
2  *
3  * Project: OpenCPN
4  * Purpose: Test driver which reads and writes data to/from files.
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 
26 #ifndef _COMM_DRV_FILE_H
27 #define _COMM_DRV_FILE_H
28 
29 #include <memory>
30 #include <sstream>
31 #include <vector>
32 #include <string>
33 
34 #include "model/comm_driver.h"
35 
36 
39 public:
41  FileCommDriver(const std::string& opath, const std::string& ipath,
42  DriverListener& l);
43 
45  FileCommDriver(const std::string& opath);
46 
47  virtual ~FileCommDriver() = default;
48 
49  bool SendMessage(std::shared_ptr<const NavMsg> msg,
50  std::shared_ptr<const NavAddr> addr) override;
51 
52  void Activate() override;
53 
54  virtual std::shared_ptr<NavAddr> GetAddress();
55 
56 private:
57  std::string output_path;
58  std::string input_path;
59  DriverListener& listener;
60 };
61 
62 #endif // COMM_DRV_FILE_H
Common interface for all drivers.
Definition: comm_driver.h:58
Interface implemented by transport layer and possible other parties like test code which should handl...
Definition: comm_driver.h:47
Read and write data to/from files test driver
Definition: comm_drv_file.h:38
FileCommDriver(const std::string &opath, const std::string &ipath, DriverListener &l)
An instance which can write to file and play data from another.
void Activate() override
Register driver in the driver Registry.
FileCommDriver(const std::string &opath)
A write-only instance writing to file.