CommandOptionRest Class Reference
[Command-Line Options]

#include <CommandOption.hpp>

Inheritance diagram for CommandOptionRest:

Inheritance graph
[legend]
Collaboration diagram for CommandOptionRest:

Collaboration graph
[legend]
List of all members.

Detailed Description

It only makes sense to have a single one of these set. CommandOption to take the rest of the command line.

It is the option that takes the rest of the command line options that are not part of any other options. e.g. "strace -ofile command arg1 arg2". The "command arg1 arg2" part is placed in objects of this class.

Definition at line 404 of file CommandOption.hpp.

Public Member Functions

 CommandOptionRest (const std::string &desc, const bool required=false)
 CommandOptionRest contructor.
virtual ~CommandOptionRest ()
 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.

Protected Member Functions

 CommandOptionRest ()
 Default Constructor.


Constructor & Destructor Documentation

CommandOptionRest const std::string &  desc,
const bool  required = false
[inline]
 

CommandOptionRest contructor.

This sets the CommandOptionType for this object to trailingType.

Parameters:
desc short description of the option
required true if option is required

Definition at line 414 of file CommandOption.hpp.

virtual ~CommandOptionRest  )  [inline, virtual]
 

Destructor.

Definition at line 420 of file CommandOption.hpp.

CommandOptionRest  )  [inline, protected]
 

Default Constructor.

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


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