OFConsoleApplication Class Reference
support class for console applications.
More...
List of all members.
Public Member Functions |
| OFConsoleApplication (const char *app, const char *desc=NULL, const char *rcsid=NULL) |
| constructor
|
| ~OFConsoleApplication () |
| destructor
|
OFBool | parseCommandLine (OFCommandLine &cmd, int argCount, char *argValue[], const int flags=0, const int startPos=1) |
| parse command line.
|
void | printHeader (const OFBool hostInfo=OFFalse, const OFBool stdError=OFFalse) |
| print header of console application (consisting of identifier, name and description)
|
void | printUsage (const OFCommandLine *cmd=NULL) |
| print usage (syntax of command line options) to standard output stream
|
void | printError (const char *str, const int code=1) |
| print error message (incl.
|
void | printWarning (const char *str, const char *prefix="warning") |
| print warning message (w/o header) to standard error stream
|
void | printMessage (const char *str) |
| print message (w/o header) to standard error stream.
|
OFBool | quietMode () const |
| check quiet mode
|
void | setQuietMode (const OFBool mode=OFTrue) |
| switch on/off quiet mode
|
void | checkValue (const OFCommandLine::E_ValueStatus status, OFCommandLine *cmd=NULL) |
| check value status and print error message if necessary
|
void | checkParam (const OFCommandLine::E_ParamValueStatus status, OFCommandLine *cmd=NULL) |
| check parameter status and print error message if necessary
|
void | checkDependence (const char *subOpt, const char *baseOpt, OFBool condition) |
| check dependence between sub and base option and report an error if required.
|
void | checkConflict (const char *firstOpt, const char *secondOpt, OFBool condition) |
| check conflict between two options and report an error if required.
|
Private Member Functions |
| OFConsoleApplication (const OFConsoleApplication &) |
OFConsoleApplication & | operator= (const OFConsoleApplication &) |
Private Attributes |
OFString | Name |
| Name of the application (short form).
|
OFString | Description |
| Short description of the application.
|
OFString | Identification |
| Identification string (rcsid).
|
OFBool | QuietMode |
| Switch on/off error and warning messages.
|
OFCommandLine * | CmdLine |
| Pointer to associated CommandLine class.
|
Detailed Description
support class for console applications.
Builds an envelope for the OFCommandLine class to provide a consistent behaviour for all DCMTK console applications. Performs console output operations and error checking.
Definition at line 53 of file ofconapp.h.
Constructor & Destructor Documentation
OFConsoleApplication::OFConsoleApplication |
( |
const char * |
app, |
|
|
const char * |
desc = NULL , |
|
|
const char * |
rcsid = NULL | |
|
) |
| | |
constructor
- Parameters:
-
| app | application name |
| desc | (short) description of what the application does |
| rcsid | identifier for console application |
Member Function Documentation
void OFConsoleApplication::checkConflict |
( |
const char * |
firstOpt, |
|
|
const char * |
secondOpt, |
|
|
OFBool |
condition | |
|
) |
| | |
check conflict between two options and report an error if required.
Message format: "error: " + firstOpt + " not allowed with " + secondOpt
- Parameters:
-
| firstOpt | first option to be checked |
| secondOpt | second option to be checked |
| condition | if true error message is printed (i.e. a conflict exists) |
void OFConsoleApplication::checkDependence |
( |
const char * |
subOpt, |
|
|
const char * |
baseOpt, |
|
|
OFBool |
condition | |
|
) |
| | |
check dependence between sub and base option and report an error if required.
Message format: "error: " + subOpt + " only allowed with " + baseOpt
- Parameters:
-
| subOpt | option to be checked |
| baseOpt | base option required for sub option |
| condition | if false error message is printed (i.e. base option is absent) |
check parameter status and print error message if necessary
- Parameters:
-
check value status and print error message if necessary
- Parameters:
-
OFBool OFConsoleApplication::parseCommandLine |
( |
OFCommandLine & |
cmd, |
|
|
int |
argCount, |
|
|
char * |
argValue[], |
|
|
const int |
flags = 0 , |
|
|
const int |
startPos = 1 | |
|
) |
| | |
parse command line.
If the command line has no argument (in case at least one argument is required) and if the command line has only one argument, namely "--help" or the specified shortcut, (in all cases) the usage is printed (see printUsage).
- Parameters:
-
| cmd | reference to the OFCommandLine object |
| argCount | number of arguments (argc) |
| argValue | pointer to argument array (argv[]) |
| flags | flags to be used for parsing (e.g. OFCommandLine::ExpandWildcards) |
| startPos | first argument to be parsed (default: 1, i.e. omit program name) |
- Returns:
- status of parsing process, true if successful, false otherwise
void OFConsoleApplication::printError |
( |
const char * |
str, |
|
|
const int |
code = 1 | |
|
) |
| | |
print error message (incl.
header) to standard error stream and exit with error code
- Parameters:
-
| str | error message to be printed |
| code | error code to be returned (exit) |
void OFConsoleApplication::printHeader |
( |
const OFBool |
hostInfo = OFFalse , |
|
|
const OFBool |
stdError = OFFalse | |
|
) |
| | |
print header of console application (consisting of identifier, name and description)
- Parameters:
-
| hostInfo | print host information as reported by 'config.guess' if OFTrue |
| stdError | print to standard error stream if OFTrue (default: standard output) |
void OFConsoleApplication::printMessage |
( |
const char * |
str |
) |
|
print message (w/o header) to standard error stream.
- Parameters:
-
| str | message to be printed |
void OFConsoleApplication::printUsage |
( |
const OFCommandLine * |
cmd = NULL |
) |
|
print usage (syntax of command line options) to standard output stream
- Parameters:
-
| cmd | reference to command line class (default: object used for parsing) |
void OFConsoleApplication::printWarning |
( |
const char * |
str, |
|
|
const char * |
prefix = "warning" | |
|
) |
| | |
print warning message (w/o header) to standard error stream
- Parameters:
-
| str | warning message to be printed |
| prefix | prefix printed in front of the message |
OFBool OFConsoleApplication::quietMode |
( |
|
) |
const |
check quiet mode
- Returns:
- OFTrue if quiet mode is active, OFFalse otherwise
void OFConsoleApplication::setQuietMode |
( |
const OFBool |
mode = OFTrue |
) |
|
switch on/off quiet mode
- Parameters:
-
| mode | if OFTrue all error and warning messages will be suppressed |
The documentation for this class was generated from the following file: