NavFilter.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 3.0 of the License, or
//  any later version.
//
//  The GNSSTk 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
#ifndef NAVFILTER_HPP
#define NAVFILTER_HPP
 
#include <iterator>
#include <stdint.h>
#include <list>
#include "ObsID.hpp"
#include "NavFilterKey.hpp"
 
namespace gnsstk
{
 
 
   class NavFilter
   {
   public:
      typedef std::list<NavFilterKey*> NavMsgList;
 
      NavFilter();
 
      virtual void validate(NavMsgList& msgBitsIn, NavMsgList& msgBitsOut) = 0;
 
      virtual void finalize(NavMsgList& msgBitsOut) = 0;
 
      virtual unsigned processingDepth() const noexcept = 0;
 
      virtual std::string filterName() const noexcept = 0;
      virtual std::string reasonTerse() const noexcept
      { return ""; }
      virtual std::vector<std::string> reasonVerbose() const noexcept
      { return std::vector<std::string>(); }
 
      virtual void dumpRejected(std::ostream& out) const;
 
      NavMsgList rejected;
 
   protected:
      inline void accept(NavFilterKey* data, NavMsgList& msgBitsOut);
 
      inline void accept(const NavMsgList& valid, NavMsgList& msgBitsOut);
 
      inline void reject(NavFilterKey* data);
 
      inline void reject(const NavMsgList& invalid);
   };
 
 
   void NavFilter ::
   accept(NavFilterKey* data, NavMsgList& msgBitsOut)
   {
      msgBitsOut.push_back(data);
   }
 
   void NavFilter ::
   accept(const NavMsgList& valid, NavMsgList& msgBitsOut)
   {
      std::copy(valid.begin(), valid.end(),
                std::back_insert_iterator<NavMsgList>(msgBitsOut));
   }
 
   void NavFilter ::
   reject(NavFilterKey* data)
   {
      rejected.push_back(data);
   }
 
   void NavFilter ::
   reject(const NavMsgList& invalid)
   {
      std::copy(invalid.begin(), invalid.end(),
                std::back_insert_iterator<NavMsgList>(rejected));
   }
 
} // namepace gnsstk
 
#endif // NAVFILTER_HPP