Deepsolver
Public Types | Public Member Functions
Deepsolver::CliParserException Class Reference

The exception for command line parser errors. More...

Inheritance diagram for Deepsolver::CliParserException:
Deepsolver::AbstractException

List of all members.

Public Types

enum  { NoPrgName, MissedArgument }

Public Member Functions

void accept (ExceptionVisitor &visitor) const
 Calls appropriate visitor method.
 CliParserException (int code)
 The constructor with error code specification.
 CliParserException (int code, const std::string &param)
 The constructor with error code and string parameter specification.
int getCode () const
 Returns the error code.
std::string getMessage () const
 Returns a single line error description.
const std::string & getParam () const
 Returns the string parameter.
std::string getType () const
 Returns a string with short error type designation.
virtual ~CliParserException ()
 The destructor.

Detailed Description

The instances of this class are thrown by methods of the CliParser class during parsing the command line. Through the methods of this exception you can obtain various information about the problem and construct corresponding message to user.

See also:
CliParser

Constructor & Destructor Documentation

Deepsolver::CliParserException::CliParserException ( int  code) [inline]
Parameters:
[in]codeThe error code
Deepsolver::CliParserException::CliParserException ( int  code,
const std::string &  param 
) [inline]
Parameters:
[in]codeThe error code
[in]paramThe string parameter

Member Function Documentation

void Deepsolver::CliParserException::accept ( ExceptionVisitor visitor) const [inline, virtual]

This method performs invocation of corresponding visit() method of the visitor, provided by the reference. You should use it each time, when you want to make particular handling action for various exception types, as it suggested by design pattern "visitor".

Parameters:
[in]visitorThe reference to the visitor

Implements Deepsolver::AbstractException.

int Deepsolver::CliParserException::getCode ( ) const [inline]
Returns:
The error code
std::string Deepsolver::CliParserException::getMessage ( ) const [virtual]

This method returns a single line string value with error description. Usually it is the value printed to user in the error message. The value should not include error type, since it can be obtained through getType() method.

Returns:
A single line error description

Implements Deepsolver::AbstractException.

const std::string& Deepsolver::CliParserException::getParam ( ) const [inline]
Returns:
The string parameter of the error
std::string Deepsolver::CliParserException::getType ( ) const [inline, virtual]

This method returns a short string with one or two words describing the error type. For example, this method can return values like "system", "back-end" etc. A value returned by this method usually is used for error message construction.

Returns:
A short string with error type designation

Implements Deepsolver::AbstractException.