CommandOptionWithCommonTimeArg.hpp
Go to the documentation of this file.
1 //==============================================================================
2 //
3 // This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
4 //
5 // The GNSSTk is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU Lesser General Public License as published
7 // by the Free Software Foundation; either version 3.0 of the License, or
8 // any later version.
9 //
10 // The GNSSTk is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with GNSSTk; if not, write to the Free Software Foundation,
17 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
18 //
19 // This software was developed by Applied Research Laboratories at the
20 // University of Texas at Austin.
21 // Copyright 2004-2022, The Board of Regents of The University of Texas System
22 //
23 //==============================================================================
24 
25 //==============================================================================
26 //
27 // This software was developed by Applied Research Laboratories at the
28 // University of Texas at Austin, under contract to an agency or agencies
29 // within the U.S. Department of Defense. The U.S. Government retains all
30 // rights to use, duplicate, distribute, disclose, or release this software.
31 //
32 // Pursuant to DoD Directive 523024
33 //
34 // DISTRIBUTION STATEMENT A: This software has been approved for public
35 // release, distribution is unlimited.
36 //
37 //==============================================================================
38 
44 #ifndef COMMANDOPTIONWITHTIMEARG_HPP
45 #define COMMANDOPTIONWITHTIMEARG_HPP
46 
47 #include "CommandOption.hpp"
48 #include "CommonTime.hpp"
49 
50 namespace gnsstk
51 {
53 
54 
63  {
64  public:
76  const std::string& loOpt,
77  const std::string& timeFormat,
78  const std::string& desc,
79  const bool required = false)
80  : gnsstk::CommandOptionWithAnyArg(shOpt, loOpt, desc, required),
81  timeSpec(timeFormat)
82  {}
83 
86 
89  virtual std::string getArgString() const
90  { return "TIME"; }
91 
93  virtual std::string checkArguments();
94 
96  const std::vector<CommonTime>& getTime() const { return times; }
97 
98  protected:
100  std::vector<CommonTime> times;
102  std::string timeSpec;
103 
106 
107  }; // class CommandOptionWithCommonTimeArg
108 
110 
111 } // namespace gnsstk
112 
113 #endif
gnsstk::CommandOptionWithCommonTimeArg::CommandOptionWithCommonTimeArg
CommandOptionWithCommonTimeArg()
Default Constructor.
Definition: CommandOptionWithCommonTimeArg.hpp:105
gnsstk::CommandOptionWithCommonTimeArg::timeSpec
std::string timeSpec
Format used to scan times in.
Definition: CommandOptionWithCommonTimeArg.hpp:102
gnsstk::CommandOption::required
bool required
Whether or not this is a required command line option.
Definition: CommandOption.hpp:252
gnsstk::CommandOptionWithCommonTimeArg::~CommandOptionWithCommonTimeArg
virtual ~CommandOptionWithCommonTimeArg()
Destructor.
Definition: CommandOptionWithCommonTimeArg.hpp:85
gnsstk::CommandOptionWithAnyArg
Definition: CommandOption.hpp:342
gnsstk
For Sinex::InputHistory.
Definition: BasicFramework.cpp:50
gnsstk::CommandOptionWithCommonTimeArg::times
std::vector< CommonTime > times
Collection of times scanned in from the command line.
Definition: CommandOptionWithCommonTimeArg.hpp:100
gnsstk::CommandOptionWithCommonTimeArg::getArgString
virtual std::string getArgString() const
Definition: CommandOptionWithCommonTimeArg.hpp:89
CommandOption.hpp
gnsstk::CommandOptionWithCommonTimeArg::checkArguments
virtual std::string checkArguments()
Validate arguments passed using this option (and store them).
Definition: CommandOptionWithCommonTimeArg.cpp:52
CommonTime.hpp
gnsstk::CommandOptionWithCommonTimeArg::getTime
const std::vector< CommonTime > & getTime() const
Return the times scanned in from the command line.
Definition: CommandOptionWithCommonTimeArg.hpp:96
gnsstk::CommandOptionWithCommonTimeArg::CommandOptionWithCommonTimeArg
CommandOptionWithCommonTimeArg(const char shOpt, const std::string &loOpt, const std::string &timeFormat, const std::string &desc, const bool required=false)
Definition: CommandOptionWithCommonTimeArg.hpp:75
gnsstk::CommandOptionWithCommonTimeArg
Definition: CommandOptionWithCommonTimeArg.hpp:62


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:38