Bayonne2 / Common C++ 2 Framework: CommandOptionParse Class Reference

To implement this object you can call makeCommandOptionParse(); This will instantiate a dynamically allocated version of this class and parse the command line for the list of command options that are passed in.

Author: Gianni Mariani giann.nosp@m.i@ma.nosp@m.riani.nosp@m..ws

Definition at line 390 of file cmdoptns.h.

Constructor & Destructor Documentation

virtual CommandOptionParse::~CommandOptionParse ( )

pure virtual

Virtual destructor needed so that the object may be correctly deleted.

Member Function Documentation

virtual bool CommandOptionParse::argsHaveError ( )

pure virtual

Get the value of the error flag set if the parser encountered errors.

virtual void CommandOptionParse::performTask ( )

pure virtual

The method should be invoked by the main code once it has determined that the application should be started.

virtual const char* CommandOptionParse::printErrors ( )

pure virtual

Return a string of text describing the list of errors encountered.

virtual const char* CommandOptionParse::printUsage ( )

pure virtual

Return a string that contains the usage description of this list of paramaters.

virtual void CommandOptionParse::registerError ( const char * errMsg )

pure virtual

This string will be appended to the errors already buffered in this object.

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

cmdoptns.h

Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by doxygen 1.8.6