Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples | Search for 

CommandOptionWithNumberArg Class Reference
[Command-Line Options]

#include <CommandOption.hpp>

Inheritance diagram for CommandOptionWithNumberArg:

Inheritance graph
[legend]
Collaboration diagram for CommandOptionWithNumberArg:

Collaboration graph
[legend]
List of all members.

Detailed Description

A CommandOption that requires a numeric argument.

Definition at line 370 of file CommandOption.hpp.

Public Member Functions

 CommandOptionWithNumberArg (const char shOpt, const std::string &loOpt, const std::string &desc, const bool required=false)
 Constructor.
virtual ~CommandOptionWithNumberArg ()
 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

 CommandOptionWithNumberArg ()
 Default Constructor.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 374 of file CommandOption.hpp.

virtual ~CommandOptionWithNumberArg (   )  [inline, virtual]
 

Destructor.

Definition at line 382 of file CommandOption.hpp.

CommandOptionWithNumberArg (   )  [inline, protected]
 

Default Constructor.

Definition at line 392 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 189 of file CommandOption.cpp.

References CommandOption::getOptionString(), and gpstk::StringUtils::isDigitString().

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

Returns a string with the argument format.

Reimplemented from CommandOption.

Definition at line 387 of file CommandOption.hpp.

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 03:31:34 2012 for GPS ToolKit Software Library by  doxygen 1.3.9.1