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

The exception class for md5file syntax errors. More...

Inheritance diagram for Deepsolver::Md5FileException:
Deepsolver::DeepsolverException

List of all members.

Public Types

enum  { TooShortLine = 0, InvalidChecksumFormat = 2 }

Public Member Functions

int getCode () const
 Returns the type of encountered error.
const std::string & getFileName () const
 Returns the name of a file with invalid line.
const std::string & getLine () const
 Returns the text of the invalid line.
size_t getLineNumber () const
 Returns number of an invalid line in file.
std::string getMessage () const
 Returns a single line error description.
std::string getType () const
 Returns a string with error type.
 Md5FileException (int code, const std::string &fileName, size_t lineNumber, const std::string &line)
 The constructor.
virtual ~Md5FileException ()
 The destructor.

Detailed Description

This class instance is thrown when md5file syntax error isCon encountered. The client application can access various information with it about the problem like file name, line number, line content and error code.

See also:
Md5File Md5

Constructor & Destructor Documentation

Deepsolver::Md5FileException::Md5FileException ( int  code,
const std::string &  fileName,
size_t  lineNumber,
const std::string &  line 
) [inline]
Parameters:
[in]codeThe error code describing the type of error
[in]fileNameName of a file being processed
[in]lineNumberThe number of a line with encountered error
[in]lineThe text of an invalid line

Member Function Documentation

int Deepsolver::Md5FileException::getCode ( ) const [inline]

Use this method to get type of an error.

Returns:
The encountered error code
const std::string& Deepsolver::Md5FileException::getFileName ( ) const [inline]

Use this method to get name of a file with an invalid line.

Returns:
Name of a file with an invalid line
const std::string& Deepsolver::Md5FileException::getLine ( ) const [inline]

Use this method to get text of the invalid line.

Returns:
The content of the invalid line
size_t Deepsolver::Md5FileException::getLineNumber ( ) const [inline]

Use this method to get number of line with the syntax problem.

Returns:
Number of an invalid line
std::string Deepsolver::Md5FileException::getMessage ( ) const [inline, virtual]

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

Returns:
A single line error description

Implements Deepsolver::DeepsolverException.

std::string Deepsolver::Md5FileException::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 description

Implements Deepsolver::DeepsolverException.