Differentiator.hpp

Go to the documentation of this file.

#pragma ident "$Id$"

#ifndef GPSTK_DIFFERENTIATOR_HPP
#define GPSTK_DIFFERENTIATOR_HPP

//============================================================================
//
//  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
//
//  Dagoberto Salazar - gAGE ( http://www.gage.es ). 2011
//
//============================================================================



#include "ProcessingClass.hpp"
#include "FIRDifferentiator5thOrder.hpp"



namespace gpstk
{



   class Differentiator : public ProcessingClass
   {
      public:

      Differentiator()
         : inputType(TypeID::L1), outputType(TypeID::L1dot),
           tolerance(0.005), useSatArcs(true), watchCSFlag(TypeID::CSL1)
      { setSamplingPeriod(1.0); setIndex(); };


      Differentiator( const TypeID& inType,
                      const TypeID& outType,
                      double samplingPeriod,
                      double tol,
                      bool useArc = true );


      virtual void Reset(void)
      { svData.clear(); return; };


      virtual TypeID getInputType() const
      { return inputType; };


      virtual Differentiator& setInputType(const TypeID& inType)
      { inputType = inType; return (*this); };


      virtual TypeID getOutputType() const
      { return outputType; };


      virtual Differentiator& setOutputType(const TypeID& outType)
      { outputType = outType; return (*this); };


      virtual bool getUseSatArc() const
      { return useSatArcs; };


      virtual Differentiator& setUseSatArc(bool useArc)
      { useSatArcs = useArc; return (*this); };


      virtual TypeID getCSFlag() const
      { return watchCSFlag; };


      virtual Differentiator& setCSFlag(const TypeID& watchFlag)
      { watchCSFlag = watchFlag; return (*this); };


      virtual double getSamplingPeriod() const
      { return Ts; };


      virtual Differentiator& setSamplingPeriod(double samplingPeriod);


      virtual double getTolerance() const
      { return tolerance; };


      virtual Differentiator& setTolerance(double tol);


      virtual double getDelay() const
      { return delay; };


      virtual std::map<SourceID, std::map<SatID, double> >
         getSvDerivativesMap() const
      { return svDerivativesMap; };


      double getValue( const SourceID& source,
                       const SatID& satellite ) const
         throw( SourceIDNotFound, SatIDNotFound );


      virtual gnssSatTypeValue& Process(gnssSatTypeValue& gData)
         throw(ProcessingException);


      virtual gnssRinex& Process(gnssRinex& gData)
         throw(ProcessingException);


      virtual gnssDataMap& Process(gnssDataMap& gData)
         throw(ProcessingException);


      virtual int getIndex(void) const;


      virtual std::string getClassName(void) const;


      virtual ~Differentiator() {};


   private:


      struct filterData
      {
            // Default constructor initializing the data in the structure
         filterData() : arcNumber(0.0),
                        previousEpoch(DayTime::BEGINNING_OF_TIME),
                        filter(1.0) {};

         double arcNumber;                   
         DayTime previousEpoch;              
         FIRDifferentiator5thOrder filter;   

         // NOTE: Change the former to obtain another differentiation
      };


   protected:


      TypeID inputType;


      TypeID outputType;


      double Ts;


      double tolerance;


      double delay;


      bool useSatArcs;


      TypeID watchCSFlag;


      std::map<SourceID, std::map<SatID, double> > svDerivativesMap;


      std::map<SourceID, std::map<SatID, filterData> > svData;


      void Compute( const DayTime& epoch,
                    const SourceID& source,
                    const satTypeValueMap& gData )
         throw(ProcessingException);


   private:


      static int classIndex;


      int index;


      void setIndex(void)
      { index = classIndex++; };


   }; // End of class 'Differentiator'



}  // End of namespace gpstk

#endif   // GPSTK_DIFFERENTIATOR_HPP

---