navmsg_filter.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2025  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, see <https://www.gnu.org/licenses/>. *
 **************************************************************************/
 
#ifndef MONITOR_FILTER_H_
#define MONITOR_FILTER_H_

 
#include <cassert>
#include <memory>
#include <set>
#include <string>
#include <unordered_map>
 
#include "model/comm_navmsg.h"
 
#include "std_filesystem.h"

class NavmsgStatus {
public:
  enum class Direction { kInput, kHandled, kOutput, kInternal, kNone };
  enum class Accepted { kOk, kFilteredNoOutput, kFilteredDropped, kNone };
  enum class State { kOk, kChecksumError, kMalformed, kTxError, kNone };
 
  NavmsgStatus(Direction direction_, State status_, Accepted accepted_)
      : direction(direction_), status(status_), accepted(accepted_) {}
 
  NavmsgStatus(Direction direction)
      : NavmsgStatus(direction, State::kOk, Accepted::kOk) {}
 
  NavmsgStatus(State status)
      : NavmsgStatus(Direction::kInput, status, Accepted::kOk) {}
 
  NavmsgStatus(Accepted accepted)
      : NavmsgStatus(Direction::kInput, State::kOk, accepted) {}
 
  NavmsgStatus() : NavmsgStatus(Direction::kInput, State::kOk, Accepted::kOk) {}

  static std::string AcceptedToString(Accepted);

  static Accepted StringToAccepted(const std::string& s);
 
  Direction direction;
  State status;
  Accepted accepted;
};
 
class NavmsgFilter {
public:
  NavmsgFilter() : m_is_valid(true) {}
 
  NavmsgFilter(bool is_valid) : m_is_valid(is_valid) {}

  static std::vector<NavmsgFilter> GetSystemFilters();

  static std::vector<NavmsgFilter> GetFilters(const fs::path& path);

  static std::vector<NavmsgFilter> GetAllFilters();

  static NavmsgFilter Parse(const std::string& s);

  static NavmsgFilter Parse(const fs::path& path);

  std::string to_string() const;

  bool Pass(NavmsgStatus status, const std::shared_ptr<const NavMsg>& msg);

  std::string GetName();

  void SetName(const std::string& new_name);
 
  bool m_is_valid;
  std::string m_name;
  std::string m_description;
  std::set<NavmsgStatus::Direction> directions;
  std::set<NavmsgStatus::State> status;
  std::set<NavmsgStatus::Accepted> accepted;
  std::set<NavAddr::Bus> buses;       // Set of buses included
  std::set<std::string> include_msg;  // Set of message ids included
  std::set<std::string> exclude_msg;  // Set of message ids excluded
  std::set<std::string> interfaces;   // Set of included interfaces
  std::set<N2kPGN> pgns;              // Nmea200 only
  std::set<N2kName> src_pgns;         // Nmea200 only
};
 
#endif  // MONITOR_FILTER