Class for file related options.
More...
#include <yat/utility/OptionInFile.h>
List of all members.
Detailed Description
Class for file related options.
- Deprecated:
- Provided for backward compatibility with the 0.5 API. Use OptionFile and StreamRedirect instead (see CommandLine for example code).
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
cmd | Commandline Option is associated with |
name | string such as "file" for --file, "f" for -f or "f,file" for having both short and long option name |
desc | string used in help display |
required | If true option must be found in commandline or exception is thrown in validation |
Member Function Documentation
set description
- Since:
- New in yat 0.7
- Returns:
- ifstream corresponding to value(). If option was not found during parsing, std::cin is returned.
- Returns:
- long name e.g. 'help' for --help option.
Get if option was found in cmd.
- Returns:
- true if option has been detected in parsing
print help output
This function calls the four virtual private functions print1, print2, print3, and print4. This allows an inherited class to implement one (or several) of these functions and keep the default output of the others. The default behavior is that:
- Parameters:
-
arg | string to be used in help output such as `=TARGET' in `--target=TARGET'. See print3(). |
- Since:
- New in yat 0.5.
- Returns:
- true if Option is required, i.e., if Option is not found during parsing an exception will be thrown.
- Returns:
- short name e.g. 'h' for -h option.
set value
- Since:
- new in yat 0.5
The documentation for this class was generated from the following file: