GalINavHealth.cpp

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.
//
//==============================================================================
#include "GalINavHealth.hpp"
 
using namespace std;
 
namespace gnsstk
{
   GalINavHealth ::
   GalINavHealth()
         : sigHealthStatus(GalHealthStatus::Unknown),
           dataValidityStatus(GalDataValid::Unknown),
           sisaIndex(255)
   {
      weekFmt = "%4L(%4l)";
      msgLenSec = 2.0;
   }
 
 
   void GalINavHealth ::
   dump(std::ostream& s, DumpDetail dl) const
   {
      const ios::fmtflags oldFlags = s.flags();
      s.setf(ios::fixed, ios::floatfield);
      s.setf(ios::right, ios::adjustfield);
      s.setf(ios::uppercase);
      s.precision(0);
      s.fill(' ');
      switch (dl)
      {
         case DumpDetail::OneLine:
            NavData::dump(s,dl);
            break;
         case DumpDetail::Brief:
            NavData::dump(s,dl);
            s << "  sigHealthStatus = "
              << static_cast<unsigned>(sigHealthStatus)
              << "  " << gnsstk::StringUtils::asString(sigHealthStatus) << endl
              << "  dataValidityStatus = "
              << static_cast<unsigned>(dataValidityStatus)
              << "  " << gnsstk::StringUtils::asString(dataValidityStatus)
              << endl
              << "  sigInSpaceAcc = " << static_cast<unsigned>(sisaIndex) <<endl
              << "  health = " << gnsstk::StringUtils::asString(getHealth())
              << endl;
            break;
         case DumpDetail::Full:
               // "header"
            s << "*************************************************************"
              << "***************" << endl
              << "Satellite Health"
              << endl
              << endl
              << getSignalString() << endl
              << "           TIMES OF INTEREST"
              << endl << endl
              << "              " << getDumpTimeHdr(dl) << endl
              << "Transmit:     " << getDumpTime(dl, timeStamp) << endl
              << endl
              << "           HEALTH DATA" << endl
              << "SHS Bits           0x" << hex << setw(1)
              << static_cast<unsigned>(sigHealthStatus) << dec << " ("
              << StringUtils::asString(sigHealthStatus) << ")" << endl
              << "DVS Bits           0x" << hex << setw(1)
              << static_cast<unsigned>(dataValidityStatus) << dec << " ("
              << StringUtils::asString(dataValidityStatus) << ")" << endl
              << "SISA Index         " << dec
              << static_cast<unsigned>(sisaIndex) << endl
              << "Status             " << StringUtils::asString(getHealth())
              << endl << endl;
            break;
      }
      s.flags(oldFlags);
   }
 
 
   SVHealth GalINavHealth ::
   getHealth() const
   {
      return galHealth(sigHealthStatus, dataValidityStatus, sisaIndex);
   }
 
 
   SVHealth GalINavHealth ::
   galHealth(GalHealthStatus shs, GalDataValid dvs, uint8_t sisa)
   {
         // This logic corresponds to Table 6 and Figure 4 of Galileo
         // Open Signal System Description Document (Galileo-OS-SDD
         // v1.1).
         // Note that what the OS-SDD refers to as "marginal", our
         // enumeration name is "Degraded".
      switch (shs)
      {
         case GalHealthStatus::OutOfService:
         case GalHealthStatus::InTest:
            return SVHealth::Unhealthy;
         case GalHealthStatus::WillBeOOS:
            return SVHealth::Degraded;
         case GalHealthStatus::OK:
            switch (dvs)
            {
               case GalDataValid::NoGuarantee:
                  return SVHealth::Degraded;
               case GalDataValid::Valid:
                  if (sisa == 255)
                     return SVHealth::Degraded;
                  else if (sisa < 255)
                     return SVHealth::Healthy;
                  else
                     return SVHealth::Unknown;
               default:
                  return SVHealth::Unknown;
            }
         default:
            return SVHealth::Unknown;
      }
   }
}