Transformer.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 GNSSTK_TRANSFORMER_HPP
#define GNSSTK_TRANSFORMER_HPP
 
#include <memory>
#include <map>
#include "Position.hpp"
#include "Xvt.hpp"
#include "Vector.hpp"
#include "RefFrame.hpp"
#include "CommonTime.hpp"
 
namespace gnsstk
{
 
 
   class Transformer
   {
   public:
         // Initialize start and end time to min and max values.
      Transformer()
            : epoch(gnsstk::CommonTime::BEGINNING_OF_TIME)
      {}
 
      virtual bool transform(const Position& fromPos, Position& toPos)
         const noexcept = 0;
 
      virtual bool transform(const Xvt& fromPos, Xvt& toPos)
         const noexcept = 0;
 
      virtual bool transform(const Vector<double>& fromPos,
                             const RefFrame& srcFrame,
                             Vector<double>& toPos)
         const noexcept = 0;
 
      virtual bool transform(const Triple& fromPos,
                             const RefFrame& srcFrame,
                             Triple& toPos)
         const noexcept = 0;
 
      virtual bool transform(double fx, double fy, double fz,
                             const RefFrame& srcFrame,
                             double& tx, double& ty, double& tz)
         const noexcept = 0;
 
      const RefFrame& getFromFrame() const noexcept
      { return fromFrame; }
      const RefFrame& getToFrame() const noexcept
      { return toFrame; }
      const CommonTime& getEpoch() const noexcept
      { return epoch; }
 
   protected:
      RefFrame fromFrame;   
      RefFrame toFrame;     
      CommonTime epoch;     
   }; // class Transformer
 
   using TransformerPtr = std::shared_ptr<Transformer>;
   using TransformerHist = std::map<CommonTime, TransformerPtr>;
   using TransformerMap = std::map<RefFramePair, TransformerHist>;
 
 
} // namespace gnsstk
 
#endif // GNSSTK_TRANSFORMER_HPP