FFBinaryStream.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_FFBINARYSTREAM_HPP
#define GNSSTK_FFBINARYSTREAM_HPP
 
#include "FFStream.hpp"
#include "BinUtils.hpp"
 
namespace gnsstk
{
 
 
   class FFBinaryStream : public FFStream
   {
   public:
      FFBinaryStream();
 
      virtual ~FFBinaryStream();
 
      FFBinaryStream(const char* fn,
                     std::ios::openmode mode=std::ios::in|std::ios::binary);
 
      virtual void open(const char* fn, std::ios::openmode mode);
 
      inline void getData(uint8_t& v);
      inline void getData(uint16_t& v);
      inline void getData(uint32_t& v);
      inline void getData(uint64_t& v);
      inline void getData(int8_t& v);
      inline void getData(int16_t& v);
      inline void getData(int32_t& v);
      inline void getData(int64_t& v);
      inline void getData(float& v);
      inline void getData(double& v);
 
      void getData(char* buff, size_t length);
 
      inline void writeData(uint8_t v);
      inline void writeData(uint16_t v);
      inline void writeData(uint32_t v);
      inline void writeData(uint64_t v);
      inline void writeData(int8_t v);
      inline void writeData(int16_t v);
      inline void writeData(int32_t v);
      inline void writeData(int64_t v);
      inline void writeData(float v);
      inline void writeData(double v);
      void writeData(const char* buff, size_t length);
 
      virtual bool isStreamLittleEndian() const noexcept = 0;
 
   };
 
 
// Macro because all the getData functions are basically the same.
// Use a character buffer because typed data can have bad side effects
// causing data corruption.
#define FFBIN_GET_DATA(ITOH_FN,NTOH_FN)         \
   char buf[sizeof(v)] = "";                    \
   getData(buf, sizeof(v));                     \
   if (isStreamLittleEndian())                  \
      BinUtils::ITOH_FN(buf, v);                \
   else                                         \
      BinUtils::NTOH_FN(buf, v);
 
#define FFBIN_WRITE_DATA(HTOI_FN,HTON_FN)       \
   char buf[sizeof(v)];                         \
   if (isStreamLittleEndian())                  \
      BinUtils::HTOI_FN(buf, v);                \
   else                                         \
      BinUtils::HTON_FN(buf, v);                \
   writeData(buf, sizeof(v));
 
 
   inline void FFBinaryStream :: getData(uint8_t& v)
   {
      char *buf = reinterpret_cast<char*>(&v);
      getData(buf, sizeof(v));
   }
 
   inline void FFBinaryStream :: getData(uint16_t& v)
   {
      FFBIN_GET_DATA(buitohs,buntohs);
   }
 
   inline void FFBinaryStream :: getData(uint32_t& v)
   {
      FFBIN_GET_DATA(buitohl,buntohl);
   }
 
   inline void FFBinaryStream :: getData(uint64_t& v)
   {
      FFBIN_GET_DATA(buitohll,buntohll);
   }
 
   inline void FFBinaryStream :: getData(int8_t& v)
   {
      char *buf = reinterpret_cast<char*>(&v);
      getData(buf, sizeof(v));
   }
 
   inline void FFBinaryStream :: getData(int16_t& v)
   {
      FFBIN_GET_DATA(buitohss,buntohss);
   }
 
   inline void FFBinaryStream :: getData(int32_t& v)
   {
      FFBIN_GET_DATA(buitohsl,buntohsl);
   }
 
   inline void FFBinaryStream :: getData(int64_t& v)
   {
      FFBIN_GET_DATA(buitohsll,buntohsll);
   }
 
   inline void FFBinaryStream :: getData(float& v)
   {
      FFBIN_GET_DATA(buitohf,buntohf);
   }
 
   inline void FFBinaryStream :: getData(double& v)
   {
      FFBIN_GET_DATA(buitohd,buntohd);
   }
 
 
   inline void FFBinaryStream :: writeData(uint8_t v)
   {
      char *buf = reinterpret_cast<char*>(&v);
      writeData(buf, sizeof(v));
   }
 
   inline void FFBinaryStream :: writeData(uint16_t v)
   {
      FFBIN_WRITE_DATA(buhtois,buhtons);
   }
 
   inline void FFBinaryStream :: writeData(uint32_t v)
   {
      FFBIN_WRITE_DATA(buhtoil,buhtonl);
   }
 
   inline void FFBinaryStream :: writeData(uint64_t v)
   {
      FFBIN_WRITE_DATA(buhtoill,buhtonll);
   }
 
   inline void FFBinaryStream :: writeData(int8_t v)
   {
      char *buf = reinterpret_cast<char*>(&v);
      writeData(buf, sizeof(v));
   }
 
   inline void FFBinaryStream :: writeData(int16_t v)
   {
      FFBIN_WRITE_DATA(buhtoiss,buhtonss);
   }
 
   inline void FFBinaryStream :: writeData(int32_t v)
   {
      FFBIN_WRITE_DATA(buhtoisl,buhtonsl);
   }
 
   inline void FFBinaryStream :: writeData(int64_t v)
   {
      FFBIN_WRITE_DATA(buhtoisll,buhtonsll);
   }
 
   inline void FFBinaryStream :: writeData(float v)
   {
      FFBIN_WRITE_DATA(buhtoif,buhtonf);
   }
 
   inline void FFBinaryStream :: writeData(double v)
   {
      FFBIN_WRITE_DATA(buhtoid,buhtond);
   }
 
}
#endif