FICData.hpp

Go to the documentation of this file.

#pragma ident "$Id: FICData.hpp 2432 2010-05-26 18:16:40Z afarris $"



//============================================================================
//
//  This file is part of GPSTk, the GPS Toolkit.
//
//  The GPSTk 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 2.1 of the License, or
//  any later version.
//
//  The GPSTk 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 GPSTk; if not, write to the Free Software Foundation,
//  Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//  
//  Copyright 2004, The University of Texas at Austin
//
//============================================================================

//============================================================================
//
//This software 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 FICDATA_HPP
#define FICDATA_HPP

#include <vector>
#include <map>

#include "FFStream.hpp"
#include "FICBase.hpp"
#include "EngEphemeris.hpp"
#include "AlmOrbit.hpp"
#include "DayTime.hpp"

namespace gpstk
{
   NEW_EXCEPTION_CLASS(WrongBlockNumber, gpstk::Exception);
      
   NEW_EXCEPTION_CLASS(WrongBlockFormat, gpstk::Exception);

   class FICData : public FICBase
   {
   public:
      FICData() : blockNum(0) {}

         /*
          * Construct a FICData from an EngEphemeris object.
          * @param engEph the EngEphemeris to copy
          */
         // if you uncomment this, fix the doxygen comment above as well
         //FICData(const EngEphemeris& engEph) throw();
      
      virtual ~FICData() {}
      bool isValid() const;      

      virtual bool isData() const {return true;}

      virtual void dump(std::ostream& s) const;

      void prettyDump(std::ostream& os) const;

      bool getTransmitTime(DayTime& dt) const;

      operator EngEphemeris() const throw(WrongBlockNumber);

      operator AlmOrbit() const throw(WrongBlockNumber);

      std::string generateUniqueKey() const throw(WrongBlockNumber,
                                                  WrongBlockFormat);

        /***
         * Standard equality operator.
         */
      bool operator==(const FICData& rhs);

     /***
      * Returns a human readable string describing an entry
      * in a FIC vector.
      * @param block Block number: 9, 109, 62, 162.
      * @param type Which vector type. 'f' for floating, 'i' for integer, 'c' for character.
      * @param indx The number of the element in the vector to describe. Starts with zero.
      * @return String describing the entry.
      */
      std::string getElementLabel(char type, size_t indx) const;
  


      static const std::string blockString; 
      long blockNum;             
      std::vector<double> f;          
      std::vector<long> i;            
      std::vector<char> c;            


   protected:
      virtual void reallyPutRecord(FFStream& s) const 
         throw(std::exception, gpstk::StringUtils::StringException, 
               gpstk::FFStreamError);
      virtual void reallyGetRecord(FFStream& s)
         throw(std::exception, gpstk::StringUtils::StringException, 
               gpstk::FFStreamError);

   private:
      void prettyDump9(std::ostream& o) const;
      void prettyDump109(std::ostream& o) const;
      void prettyDump62(std::ostream& o) const;
      void prettyDump162(std::ostream& o) const;

      void timeDisplay( std::ostream & os, const char * legend,
                        const short week, const double SOW, 
                        const short headerFlag ) const;

      void shortcut(std::ostream & os, const double HOW ) const;
   };
   
}

#endif // FICDATA_HPP

---