VoiceMan
Public Member Functions | List of all members
ConfigurationException Class Reference

The exception class to handle configuration errors. More...

Inheritance diagram for ConfigurationException:
VoicemanException

Public Member Functions

 ConfigurationException (const std::string &comment)
 The constructor. More...
 
std::string getMessage () const
 Returns exception description. More...
 
void makeLogReport (int level) const
 Makes report to logging system. More...
 
virtual ~ConfigurationException ()
 The destructor.
 
- Public Member Functions inherited from VoicemanException
 VoicemanException ()
 The default constructor.
 
virtual ~VoicemanException ()
 The destructor.
 

Detailed Description

This class is used to notify about an error during configuration data processing and store all necessary information. This class must not be confused with configuration file parsing errors. This class is used only for semantics errors.

See also
ConfigFileException ConfigFileValueTypeException

Constructor & Destructor Documentation

ConfigurationException::ConfigurationException ( const std::string &  comment)
inline
Parameters
[in]commentThe single-line error description

Member Function Documentation

std::string ConfigurationException::getMessage ( ) const
inlinevirtual

This method generates single line description of the error object. returned string can be printed to console or to log as error report.

Returns
The single-line error description

Implements VoicemanException.

void ConfigurationException::makeLogReport ( int  level) const
inlinevirtual

This function writes to log a report about error object. It may be not exactly the same value as produced by getMessage() method. The level of message must be specified, because the same error can have different levels in different situations.

Parameters
levelThe level of error log report

Implements VoicemanException.