OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
OFConsoleApplication Class Reference

support class for console applications. More...

Collaboration diagram for OFConsoleApplication:
[legend]

Public Member Functions

 OFConsoleApplication (const char *app, const char *desc=NULL, const char *rcsid=NULL)
 constructor More...
 
 ~OFConsoleApplication ()
 destructor
 
OFBool parseCommandLine (OFCommandLine &cmd, int argCount, char *argValue[], const int flags=0, const int startPos=1)
 parse command line. More...
 
void printHeader (const OFBool hostInfo=OFFalse, const OFBool stdError=OFFalse)
 print header of console application (consisting of identifier, name and description) More...
 
void printUsage (const OFCommandLine *cmd=NULL)
 print usage (syntax of command line options) to standard output stream More...
 
void printArguments (OFCommandLine *cmd=NULL)
 print expanded command line arguments to standard error stream More...
 
void printIdentifier ()
 print resource identifier to standard error stream
 
void printError (const char *str, const int code=1)
 print error message (incl. More...
 
void printWarning (const char *str, const char *prefix="warning")
 print warning message (w/o header) to standard error stream More...
 
void printMessage (const char *str)
 print message (w/o header) to standard error stream. More...
 
OFBool quietMode () const
 check quiet mode More...
 
void setQuietMode (const OFBool mode=OFTrue)
 switch on/off quiet mode More...
 
void checkValue (const OFCommandLine::E_ValueStatus status, OFCommandLine *cmd=NULL)
 check value status and print error message if necessary More...
 
void checkParam (const OFCommandLine::E_ParamValueStatus status, OFCommandLine *cmd=NULL)
 check parameter status and print error message if necessary More...
 
void checkDependence (const char *subOpt, const char *baseOpt, OFBool condition)
 check dependence between sub and base option and report an error if required. More...
 
void checkConflict (const char *firstOpt, const char *secondOpt, OFBool condition)
 check conflict between two options and report an error if required. More...
 

Private Member Functions

 OFConsoleApplication (const OFConsoleApplication &)
 
OFConsoleApplicationoperator= (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.
 
OFCommandLineCmdLine
 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 49 of file ofconapp.h.

Constructor & Destructor Documentation

OFConsoleApplication::OFConsoleApplication ( const char *  app,
const char *  desc = NULL,
const char *  rcsid = NULL 
)

constructor

Parameters
appapplication name
desc(short) description of what the application does
rcsididentifier 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
firstOptfirst option to be checked
secondOptsecond option to be checked
conditionif 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
subOptoption to be checked
baseOptbase option required for sub option
conditionif false error message is printed (i.e. base option is absent)
void OFConsoleApplication::checkParam ( const OFCommandLine::E_ParamValueStatus  status,
OFCommandLine cmd = NULL 
)

check parameter status and print error message if necessary

Parameters
statusstatus of OFCommandLine::getParam() call
cmdreference to command line class (default: object used for parsing)
void OFConsoleApplication::checkValue ( const OFCommandLine::E_ValueStatus  status,
OFCommandLine cmd = NULL 
)

check value status and print error message if necessary

Parameters
statusstatus of OFCommandLine::getValue() call
cmdreference to command line class (default: object used for parsing)
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
cmdreference to the OFCommandLine object
argCountnumber of arguments (argc)
argValuepointer to argument array (argv[])
flagsflags to be used for parsing (e.g. OFCommandLine::PF_ExpandWildcards)
startPosfirst argument to be parsed (default: 1, i.e. omit program name)
Returns
status of parsing process, true if successful, false otherwise
void OFConsoleApplication::printArguments ( OFCommandLine cmd = NULL)

print expanded command line arguments to standard error stream

Parameters
cmdreference to command line class (default: object used for parsing)
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
strerror message to be printed
codeerror 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
hostInfoprint host information as reported by 'config.guess' if OFTrue
stdErrorprint 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
strmessage to be printed
void OFConsoleApplication::printUsage ( const OFCommandLine cmd = NULL)

print usage (syntax of command line options) to standard output stream

Parameters
cmdreference 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
strwarning message to be printed
prefixprefix 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
modeif OFTrue all error and warning messages will be suppressed

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


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11