OpenCPN Partial API docs
Loading...
Searching...
No Matches
filters_on_disk.h
Go to the documentation of this file.
1/***************************************************************************
2 * Copyright (C) 2025 Alec Leamas *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, see <https://www.gnu.org/licenses/>. *
16 **************************************************************************/
17
28#include <string>
29#include <vector>
30
31#include "model/navmsg_filter.h"
32
33namespace filters_on_disk {
34
36std::vector<std::string> List(bool include_system = false);
37
42bool Exists(const std::string& name);
43
45bool Remove(const std::string& name);
46
48bool Write(const NavmsgFilter& filter, const std::string& name);
49
51NavmsgFilter Read(const std::string& name);
52
53} // namespace filters_on_disk
std::vector< std::string > List(bool include_system)
Return list of filters, possibly including also the system ones.
NavmsgFilter Read(const std::string &name)
Read filter with given name from disk.
bool Remove(const std::string &name)
Remove a filter, return ok if no errors.
bool Write(const NavmsgFilter &filter, const std::string &name)
Write contents for given filter to disk.
bool Exists(const std::string &name)
Return true iff filter with given name exists, either system or user defined.
Data monitor filter definitions.