FileSpec.hpp

Go to the documentation of this file.

#pragma ident "$Id: FileSpec.hpp 930 2007-11-27 16:57:42Z snelsen $"



#ifndef GPSTK_FILESPEC_HPP
#define GPSTK_FILESPEC_HPP

#include <vector>
#include <functional>
#include <map>

//============================================================================
//
//  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.
//
//=============================================================================






#include "DayTime.hpp"

#ifdef _WIN32
const char slash = '\\';
#else
const char slash = '/';
#endif

namespace gpstk
{

   NEW_EXCEPTION_CLASS(FileSpecException, gpstk::Exception);

   class FileSpec
   {
   public:
      enum FileSpecType
      {
         unknown,       
         station,       
         receiver,      
         prn,           
         selected,      
         sequence,      
         version,       

         fixed,         
         clock,         
         text,          


            // see DayTime for more information on the following elements
         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
      {
         none,
         ascending,
         descending
      };

      FileSpec() {}

      FileSpec(const std::string& fileSpec)
         throw(FileSpecException)
         {init(fileSpec);}

      virtual ~FileSpec() {}

      virtual FileSpec& newSpec(const std::string& fileSpec)
         throw(FileSpecException)
         {init(fileSpec); return *this;}

      virtual std::string getSpecString(void) const
         {return fileSpecString;}

      virtual std::string createSearchString() const
         throw(FileSpecException);

      virtual std::string extractField(const std::string& filename, 
                               const FileSpecType) const
         throw(FileSpecException);

      virtual bool hasField(const FileSpecType) const
         throw(FileSpecException);

      virtual gpstk::DayTime extractDayTime(const std::string& filename) const
         throw(FileSpecException);

      virtual std::string toString(const gpstk::DayTime& dt,
                                   const FSTStringMap& fstsMap = FSTStringMap()) 
         const;

      virtual void sortList(std::vector<std::string>& fileList, 
                    const FileSpecSortType fsst = ascending) const
         throw(FileSpecException);

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

   protected:
      virtual void init(const std::string& fileSpec)
         throw(FileSpecException);

   public:
      static std::string convertFileSpecType(const FileSpecType)
         throw(FileSpecException);

      static FileSpecType convertFileSpecType(const std::string&)
         throw(FileSpecException);

   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(std::string::size_type o, std::string::size_type l,
                      const FileSpecSortType s)
               : offset(o), length(l), sortBy(s) {}
         bool operator() (const std::string& l, const std::string& r) const;
      private:
         std::string::size_type offset;
         std::string::size_type length;
         FileSpecSortType sortBy;
      };

      std::vector<FileSpecElement> fileSpecList;
      std::string fileSpecString;
          
      
   }; // class FileSpec

   FileSpec::FileSpecType& operator-- (FileSpec::FileSpecType& fst, int);
   FileSpec::FileSpecType& operator++ (FileSpec::FileSpecType& fst, int);


} // namespace gpstk

#endif 

---