gatb.core-API-0.0.0
Public Member Functions | List of all members
OptionFailure Class Reference

Exception class to be used for option management error. More...

#include <OptionsParser.hpp>

Public Member Functions

 OptionFailure (IOptionsParser *parser, IOptionsParser::Result result)
 
 OptionFailure (IOptionsParser *parser, const std::string &msg)
 
int displayErrors (std::ostream &os) const
 

Detailed Description

Exception class to be used for option management error.

This class should be thrown when something went wrong during options parsing.

Constructor & Destructor Documentation

OptionFailure ( IOptionsParser *  parser,
IOptionsParser::Result  result 
)
inline

Constructor.

Parameters
[in]parser: the parser that threw the exception.
[in]result: information gathered during the parsing.
OptionFailure ( IOptionsParser *  parser,
const std::string &  msg 
)
inline

Constructor.

Parameters
[in]parser: the parser that threw the exception.
[in]msg: message to be displayed

Member Function Documentation

int displayErrors ( std::ostream &  os) const

Display information about the failure on the provided output stream

Parameters
[out]os: output stream to be used
Returns
EXIT_FAILURE
The documentation for this class was generated from the following files: