FileSpec.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_FILESPEC_HPP
#define GNSSTK_FILESPEC_HPP
 
#include <vector>
#include <functional>
#include <map>
#include <set>
 
#include "CommonTime.hpp"
 
#ifdef WIN32
const char slash = '\\';
#else
const char slash = '/';
#endif
 
namespace gnsstk
{
   NEW_EXCEPTION_CLASS(FileSpecException, gnsstk::Exception);
 
 
 
   class FileSpec
   {
   public:
      enum FileSpecType
      {
         unknown,       
         station,       
         receiver,      
         prn,           
         selected,      
         sequence,      
         version,       
         fixed,         
         clock,         
         text,          
 
 
            // see CommonTime for more information on the following elements
         year,          
         firstTime = year, 
         month,         
         dayofmonth,    
         hour,          
         minute,        
         second,        
         fsecond,       
         gpsweek,       
         fullgpsweek,   
         gpssecond,     
         mjd,           
         dayofweek,     
         day,           
         doysecond,     
         zcount,        
         zcountfloor,   
         unixsec,       
         unixusec,      
         fullzcount,    
 
         end            
      };
 
      typedef std::map<FileSpecType, std::string> FSTStringMap;
 
 
      enum FileSpecSortType
      {
         ascending,
         descending
      };
 
      FileSpec() {}
 
      FileSpec(const std::string& fileSpec)
      {init(fileSpec);}
 
      virtual ~FileSpec() {}
 
      virtual FileSpec& newSpec(const std::string& fileSpec)
      {init(fileSpec); return *this;}
 
      virtual std::string getSpecString(void) const
      {return fileSpecString;}
 
      virtual std::string createSearchString() const;
 
      virtual std::string extractField(const std::string& filename,
                                       const FileSpecType) const;
 
      virtual bool hasField(FileSpecType fst) const
      { return fileSpecSet.count(fst) != 0; }
 
      bool hasTimeField() const
      { return fileSpecSet.lower_bound(firstTime) != fileSpecSet.end(); }
 
      bool hasNonTimeField() const
      { return (!fileSpecSet.empty() && ((*fileSpecSet.begin()) < firstTime)); }
 
      virtual gnsstk::CommonTime extractCommonTime(const std::string& filename)
         const;
 
      virtual std::string toString(const gnsstk::CommonTime& dt,
                                   const FSTStringMap& fstsMap = FSTStringMap())
         const;
 
      virtual void sortList(std::vector<std::string>& fileList,
                            const FileSpecSortType fsst = ascending) const;
 
      virtual void dump(std::ostream& o) const;
 
   protected:
      virtual void init(const std::string& fileSpec);
 
   public:
      static std::string convertFileSpecType(const FileSpecType);
 
      static FileSpecType convertFileSpecType(const std::string&);
 
   protected:
      class FileSpecElement
      {
      public:
         FileSpecElement(const std::string::size_type numChars = 0,
                         const std::string::size_type offs = 0,
                         const FileSpecType fst = unknown,
                         const std::string& fld = std::string())
               : numCh(numChars), offset(offs), type(fst), field(fld)
         {}
 
         std::string::size_type numCh;
         std::string::size_type offset;
         FileSpecType type;
         std::string field;
      };
 
      struct FileSpecSort :
         public std::binary_function<std::string,std::string,bool>
      {
      public:
         FileSpecSort(const FileSpec& fs, const FileSpecSortType s)
               : fileSpec(fs), sortDir(s) {}
         bool operator() (const std::string& l, const std::string& r) const;
      private:
         FileSpecSortType sortDir;
         const FileSpec &fileSpec;
      };
 
      std::vector<FileSpecElement> fileSpecList;
      std::set<FileSpecType> fileSpecSet;
      std::string fileSpecString;
 
      friend struct FileSpecSort;
 
   }; // class FileSpec
 
   FileSpec::FileSpecType& operator-- (FileSpec::FileSpecType& fst, int);
   FileSpec::FileSpecType& operator++ (FileSpec::FileSpecType& fst, int);
 
 
} // namespace gnsstk
 
#endif