CommandOptionWithStringArg Class Reference
[Command-Line Options]

#include <CommandOption.hpp>

Inheritance diagram for CommandOptionWithStringArg:

[legend]Collaboration diagram for CommandOptionWithStringArg:

[legend]List of all members.

---

Detailed Description

A CommandOption that requires a string argument.

Definition at line 344 of file CommandOption.hpp.

Public Member Functions
	CommandOptionWithStringArg (const char shOpt, const std::string &loOpt, const std::string &desc, const bool required=false)
	Constructor.
virtual	~CommandOptionWithStringArg ()
	Destructor.
virtual std::string	checkArguments ()
	If you specified a format for the arguments (for example, digit or string), this function checks them to see if they match.
virtual std::string	getArgString () const
	Returns a string with the argument format.
Protected Member Functions
	CommandOptionWithStringArg ()
	Default Constructor.

---

Constructor & Destructor Documentation

CommandOptionWithStringArg (  const char  shOpt, const std::string &  loOpt, const std::string &  desc, const bool  required = false )  [inline]

Constructor. Definition at line 348 of file CommandOption.hpp.

virtual ~CommandOptionWithStringArg (   )  [inline, virtual]

Destructor. Definition at line 356 of file CommandOption.hpp.

CommandOptionWithStringArg (   )  [inline, protected]

Default Constructor. Definition at line 366 of file CommandOption.hpp.

---

Member Function Documentation

string checkArguments (   )  [virtual]

If you specified a format for the arguments (for example, digit or string), this function checks them to see if they match. If they don't, an error string is returned. If they do, an empty string is returned. Parameters: optVec  complete set of processed command line options being processed (used by some option types). Reimplemented from CommandOption. Definition at line 211 of file CommandOption.cpp. References CommandOption::getOptionString(), and gpstk::StringUtils::isAlphaString().

virtual std::string getArgString (   )  const [inline, virtual]

Returns a string with the argument format. Reimplemented from CommandOption. Definition at line 361 of file CommandOption.hpp.

---

The documentation for this class was generated from the following files:

• CommandOption.hpp
• CommandOption.cpp

---