CommandOption_example_3.cpp

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.
//
//==============================================================================
#include <iostream>
#include <fstream>
#include <BasicFramework.hpp>
#include <StringUtils.hpp>
#include <CommandOptionWithCommonTimeArg.hpp>
#include <TimeString.hpp>
 
using namespace std;
using namespace gnsstk;
 
// Given that Doxygen removes Doxygen comments when rendering
// examples, please do not consider the absence of comments in the
// HTML rendering to be representative.  Refer to the file in the
// depot instead.
 
// Interesting examples:
// CommandOption3 -f "1920 12345" -f "1921 0" --scream
// CommandOption3 -f "1920 12345" -Z 1105530967 --scream
// CommandOption3 -Z 1105530967 -f "1920 12345" --scream
 
class CommandOption3Example : public BasicFramework
{
public:
   CommandOption3Example(const string& applName);
   bool initialize(int argc, char *argv[], bool pretty = true) noexcept override;
   void process() override;
   void shutDown() override;
   CommandOptionWithCommonTimeArg gpsEWSOpt;
   CommandOptionWithCommonTimeArg gpsWSOpt;
   CommandOptionWithCommonTimeArg gpsWZOpt;
   CommandOptionWithCommonTimeArg gpsZ29Opt;
   CommandOptionWithCommonTimeArg gpsZ32Opt;
   CommandOptionNOf allTimesOption;
 
   CommandOptionNoArg screamOpt;
   CommandOptionNoArg hushOpt;
   CommandOptionOneOf hushScreamOpt;
};
 
 
CommandOption3Example ::
CommandOption3Example(const string& applName)
      : BasicFramework(applName, "Example application for CommandOption"),
        gpsEWSOpt('o', "ews", "%E %G %g",
                  "\"GPSEpoch 10bitGPSweek SecondOfWeek\""),
        gpsWSOpt('f', "ws", "%F %g", "\"FullGPSWeek SecondOfWeek\""),
        gpsWZOpt('w', "wz", "%F %Z", "\"FullGPSWeek Zcount\""),
        gpsZ29Opt(0, "z29", "%E %c", "\"29bitZcount\""),
        gpsZ32Opt('Z', "z32", "%C", "\"32bitZcount\""),
        screamOpt(0, "scream", "print a message very loudly"),
        hushOpt(0, "hush", "don't print a message very loudly"),
        allTimesOption(2) // two and only two of the options must be used
{
      // Define the options that will be used.  As noted above, 2 of
      // these options must be used on the command-line.
   allTimesOption.addOption(&gpsEWSOpt);
   allTimesOption.addOption(&gpsWSOpt);
   allTimesOption.addOption(&gpsWZOpt);
   allTimesOption.addOption(&gpsZ29Opt);
   allTimesOption.addOption(&gpsZ32Opt);
      // At least one of these options must be specified, but there is
      // no restriction on whether more than one is specified
      // (setMaxCount has no effect on CommandOptionOneOf).
   hushScreamOpt.addOption(&screamOpt);
   hushScreamOpt.addOption(&hushOpt);
}
 
 
bool CommandOption3Example ::
initialize(int argc, char *argv[], bool pretty) noexcept
{
   if (!BasicFramework::initialize(argc, argv, pretty))
      return false;
      // which() constructs a new vector and returns it, so we call
      // which() once and store the data for local use.
   CommandOptionVec timeOpts = allTimesOption.which();
      // timeOpts now contains a vector of all the command-line, so we
      // can iterate through it to figure out what options were used.
   for (unsigned i = 0; i < timeOpts.size(); i++)
   {
         // In this example, the command-line options can be used
         // twice, so we iterate through the values stored in each
         // option.
         // If you want to restrict the command-line so that only a
         // certain number of a given option used in the
         // CommandOptionNOf validation, e.g. only specify GPS
         // week-second once in this example, then use the
         // setMaxCount() method on the individual options.
      for (unsigned j = 0; j < timeOpts[i]->getCount(); j++)
      {
         CommandOptionWithCommonTimeArg* opt =
            (CommandOptionWithCommonTimeArg*)timeOpts[i];
            // Because the values are stored with each command-line
            // option, we use getOrder to determine the order in which
            // the user specified the options on the command-line.
            // This isn't always necessary but the information is here
            // if needed.
         unsigned order = timeOpts[i]->getOrder(j);
         cout << "Option #" << order << " " << opt->getValue()[j]
              << " = "
              << printTime(opt->getTime()[j], "%04Y/%02m/%02d %02H:%02M:%02S")
              << endl;
      }
   }
   if (screamOpt)
   {
      cout << "HELLO WORLD x" << screamOpt.getCount() << endl;
   }
   if (hushOpt)
   {
      cout << "ok i'll be quiet x" << hushOpt.getCount() << endl;
   }
      // whichOne returns the option that was used, which is a little
      // strange given multiple can be used (CommandOptionMutex is
      // better for a "one and only one" relation).
   CommandOption *which = hushScreamOpt.whichOne();
   if (which != nullptr)
   {
      cout << "You used " << which->getFullOptionString()
           << " (and possibly others)" << endl;
   }
   return true;
}
 
 
void CommandOption3Example ::
process()
{
   cout << "Nothing to do" << endl;
}
 
 
void CommandOption3Example ::
shutDown()
{
   cout << "Shutting down" << endl;
}
 
 
int main(int argc, char *argv[])
{
   try
   {
      CommandOption3Example app(argv[0]);
      if (app.initialize(argc, argv))
      {
         app.run();
      }
      return app.exitCode;
   }
   catch (gnsstk::Exception& e)
   {
      cerr << e << endl;
   }
   catch (std::exception& e)
   {
      cerr << e.what() << endl;
   }
   catch (...)
   {
      cerr << "Caught unknown exception" << endl;
   }
   return gnsstk::BasicFramework::EXCEPTION_ERROR;
}