BasicFramework.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_BASICFRAMEWORK_HPP
#define GNSSTK_BASICFRAMEWORK_HPP
 
#include "CommandOptionParser.hpp"
#include <iostream>
#include "Exception.hpp"
 
namespace gnsstk
{
 
 
 
   class BasicFramework
   {
   public:
      static const int EXCEPTION_ERROR = 1;
      static const int GENERAL_ERROR = 1;
      static const int OPTION_ERROR = 2;
      static const int EXIST_ERROR = 2;
 
      BasicFramework( const std::string& applName,
                      const std::string& applDesc )
         noexcept;
 
 
      virtual ~BasicFramework() {};
 
 
      virtual bool initialize( int argc,
                               char *argv[],
                               bool pretty = true )
         noexcept;
 
 
      bool run() noexcept;
 
 
      int exitCode;
 
 
   protected:
 
      int debugLevel;           
      int verboseLevel;         
      std::string argv0;        
      std::string appDesc;      
 
      CommandOptionNoArg debugOption;
      CommandOptionNoArg verboseOption;
      CommandOptionHelpUsage helpOption;
 
 
      virtual void completeProcessing();
 
 
      virtual void additionalSetup()
      {}
 
 
      virtual void spinUp()
      {}
 
 
      virtual void process()
      {}
 
 
      virtual void shutDown()
      {}
 
   private:
 
 
         // Do not allow the use of the default constructor.
      BasicFramework();
 
   }; // End of class 'BasicFramework'
 
 
}  // End of namespace gnsstk
#endif   // GNSSTK_BASICFRAMEWORK_HPP