util::ConsoleUI
displays msgs on the "console".
???
Public Member Functions | |
Constructors | |
ConsoleUI (int argc, char *argv[], const char *cpszTitle=0, const char *cpszCopyright=0) | |
Instantiate a console user interface object. | |
~ConsoleUI (void) | |
destructor | |
void | setQuietMode (bool bQuiet) |
std::ostream & | getOutputStream (void) const |
void | format (const char *cpszField, const char *cpszValue) const |
display a field and a value with padding so value starts at col 40 First column is field , second column is value | |
void | format (const char *cpszField, long lValue) const |
void | format (const char *cpszField, unsigned long ulValue) const |
void | formatBool (const char *cpszField, bool bValue) const |
void | format (const char *cpszField, bool bValue) const |
void | format (const char *cpszField, int iValue) const |
void | formatHeader (const char *cpszMsg) const |
display a header | |
void | header (const char *cpszMsg) const |
display a header | |
void | horizontalBar (void) const |
display a line of dashes | |
void | newline (void) const |
display a new-line | |
void | info (const char *cpszMsg) const |
display an informational msg | |
void | warning (const char *cpszMsg1, const char *cpszMsg2=NULL) const |
display a warning msg on stderr | |
void | error (const char *cpszMsg) const |
display an error msg on stderr | |
void | fatal (int iErrcode, const char *cpszMsg1, const char *cpszMsg2=NULL) const |
display an error msg on stderr and exit | |
Usage and Help methods | |
void | handleUsageHelp (const char *cpszUsage, const char *cpszHelp, const char *cpszHelpFlags=NULL) |
process usage msg and check command-line arguments | |
void | displayUsage (void) const |
display usage or help and then exit! | |
void | displayHelp (void) const |
Process optional arguments | |
bool | hasArgString (const char *cpszArgument, const char *&cpszrValue) const |
bool | hasArgNumval (const char *cpszArgument, long &rlValue) const |
bool | hasArgSwitch (const char *cpszArgument) const |
Process positional arguments | |
bool | setToFirst (void) |
set cursor to the first command line argument and return TRUE if there is one | |
bool | setToNext (void) |
set cursor to the next command line argument and return TRUE if there is one | |
bool | isValid (void) const |
return TRUE if the current command line argument is valid | |
operator const char * (void) const | |
return current command line argument as C string pointer | |
const char * | getAsCString (void) const |
return current command line argument as C string pointer | |
Display progress indication | |
void | progressStart (void) |
void | progressStep (void) |
void | progressStop (void) const |
Protected Member Functions | |
void | format (const char *cpszMag) const |
bool | hasOption (const char *cpszArgument, const char *&cpszrValue) const |
void | debugDisplayOptions (int numOpts) |
uima::util::ConsoleUI::ConsoleUI | ( | int | argc, | |
char * | argv[], | |||
const char * | cpszTitle = 0 , |
|||
const char * | cpszCopyright = 0 | |||
) |
Instantiate a console user interface object.
argc
and argv
must be passed to the ConsoleUI
object.
uima::util::ConsoleUI::~ConsoleUI | ( | void | ) |
destructor
void uima::util::ConsoleUI::setQuietMode | ( | bool | bQuiet | ) | [inline] |
std::ostream& uima::util::ConsoleUI::getOutputStream | ( | void | ) | const [inline] |
void uima::util::ConsoleUI::format | ( | const char * | cpszField, | |
const char * | cpszValue | |||
) | const [inline] |
display a field and a value with padding so value starts at col 40 First column is field
, second column is value
Referenced by format(), and formatBool().
void uima::util::ConsoleUI::format | ( | const char * | cpszField, | |
long | lValue | |||
) | const [inline] |
References format().
void uima::util::ConsoleUI::format | ( | const char * | cpszField, | |
unsigned long | ulValue | |||
) | const [inline] |
References format().
void uima::util::ConsoleUI::formatBool | ( | const char * | cpszField, | |
bool | bValue | |||
) | const [inline] |
References format().
void uima::util::ConsoleUI::format | ( | const char * | cpszField, | |
bool | bValue | |||
) | const [inline] |
void uima::util::ConsoleUI::format | ( | const char * | cpszField, | |
int | iValue | |||
) | const [inline] |
void uima::util::ConsoleUI::formatHeader | ( | const char * | cpszMsg | ) | const [inline] |
void uima::util::ConsoleUI::header | ( | const char * | cpszMsg | ) | const [inline] |
void uima::util::ConsoleUI::horizontalBar | ( | void | ) | const [inline] |
void uima::util::ConsoleUI::newline | ( | void | ) | const [inline] |
display a new-line
void uima::util::ConsoleUI::info | ( | const char * | cpszMsg | ) | const [inline] |
void uima::util::ConsoleUI::warning | ( | const char * | cpszMsg1, | |
const char * | cpszMsg2 = NULL | |||
) | const [inline] |
display a warning msg on stderr
void uima::util::ConsoleUI::error | ( | const char * | cpszMsg | ) | const [inline] |
display an error msg on stderr
void uima::util::ConsoleUI::fatal | ( | int | iErrcode, | |
const char * | cpszMsg1, | |||
const char * | cpszMsg2 = NULL | |||
) | const [inline] |
display an error msg on stderr and exit
void uima::util::ConsoleUI::handleUsageHelp | ( | const char * | cpszUsage, | |
const char * | cpszHelp, | |||
const char * | cpszHelpFlags = NULL | |||
) |
process usage msg and check command-line arguments
void uima::util::ConsoleUI::displayUsage | ( | void | ) | const [inline] |
void uima::util::ConsoleUI::displayHelp | ( | void | ) | const [inline] |
bool uima::util::ConsoleUI::hasArgString | ( | const char * | cpszArgument, | |
const char *& | cpszrValue | |||
) | const [inline] |
References hasOption().
bool uima::util::ConsoleUI::hasArgNumval | ( | const char * | cpszArgument, | |
long & | rlValue | |||
) | const [inline] |
References hasOption().
bool uima::util::ConsoleUI::hasArgSwitch | ( | const char * | cpszArgument | ) | const [inline] |
References hasOption().
bool uima::util::ConsoleUI::setToFirst | ( | void | ) | [inline] |
set cursor to the first command line argument and return TRUE if there is one
bool uima::util::ConsoleUI::setToNext | ( | void | ) | [inline] |
set cursor to the next command line argument and return TRUE if there is one
bool uima::util::ConsoleUI::isValid | ( | void | ) | const [inline] |
return TRUE if the current command line argument is valid
uima::util::ConsoleUI::operator const char * | ( | void | ) | const [inline] |
return current command line argument as C string pointer
const char * uima::util::ConsoleUI::getAsCString | ( | void | ) | const [inline] |
return current command line argument as C string pointer
void uima::util::ConsoleUI::progressStart | ( | void | ) | [inline] |
void uima::util::ConsoleUI::progressStep | ( | void | ) | [inline] |
References gs_progressChars.
void uima::util::ConsoleUI::progressStop | ( | void | ) | const [inline] |
void uima::util::ConsoleUI::format | ( | const char * | cpszMag | ) | const [inline, protected] |
References gi_maxlen, and gs_cpszFiller.
bool uima::util::ConsoleUI::hasOption | ( | const char * | cpszArgument, | |
const char *& | cpszrValue | |||
) | const [protected] |
Referenced by hasArgNumval(), hasArgString(), and hasArgSwitch().
void uima::util::ConsoleUI::debugDisplayOptions | ( | int | numOpts | ) | [protected] |