ecl::Error Class Reference

The primary error handler for ecl libraries. More...

#include <handlers.hpp>

Public Member Functions
	Error (const ErrorFlag &flag=UnknownError)
	Configure the return type with an error flag. More...
virtual ErrorFlag	flag () const
	The flag identifying the error identified with this error handler. More...
virtual void	operator= (const ErrorFlag &error)
virtual void	print (const char *loc)
	Print a location dependent message to standard out. More...
virtual const char *	what () const
	A simple string verbosely representing the error that is handled. More...
virtual	~Error ()

Protected Member Functions
virtual const char *	argNotSupportedErrorString () const
virtual const char *	blockingErrorString () const
virtual const char *	busyErrorString () const
virtual const char *	closeErrorString () const
virtual const char *	configurationErrorString () const
virtual const char *	connectErrorString () const
virtual const char *	connectionRefusedString () const
virtual const char *	constructorErrorString () const
virtual const char *	conversionErrorString () const
virtual const char *	destructorErrorString () const
virtual const char *	interruptedErrorString () const
virtual const char *	invalidArgErrorString () const
virtual const char *	invalidObjectErrorString () const
virtual const char *	isLockedErrorString () const
virtual const char *	isTimeOutErrorString () const
virtual const char *	memoryErrorString () const
virtual const char *	noErrorString () const
virtual const char *	notFoundErrorString () const
virtual const char *	notInitialisedErrorString () const
virtual const char *	notSupportedErrorString () const
virtual const char *	openErrorString () const
virtual const char *	outOfRangeErrorString () const
virtual const char *	outOfResourcesErrorString () const
virtual const char *	permissionsErrorString () const
virtual const char *	raiiErrorString () const
virtual const char *	readErrorString () const
virtual const char *	systemFailureErrorString () const
virtual const char *	unknownErrorString () const
virtual const char *	usageErrorString () const
virtual const char *	writeErrorString () const

Protected Attributes
ErrorFlag	error_flag

Detailed Description

The primary error handler for ecl libraries.

This class is mostly used as the return type for ecl functions to indicate errors.

Error f(const int &i) {
   if ( i == 3 ) {
       return Error(NoError);
   else {
       return Error(OutOfRangeError);
   }
}

// code

Error error = f(5);
if ( error.flag() != NoError ) {
    std::cout << error.what() << std::endl; // OR
    error.print(LOC);   // for a verbose message with code location added.
}

Alternatively the class can be inherited and the verbose messages overloaded. Refer to the TimeError class in ecl_time_lite for an example.

Definition at line 58 of file handlers.hpp.

Constructor & Destructor Documentation

ecl::Error::Error ( const ErrorFlag &  flag = UnknownError )

inline

Configure the return type with an error flag.

Parameters

flag	: the type of error that is to be returned.

Definition at line 65 of file handlers.hpp.

virtual ecl::Error::~Error ( )

inlinevirtual

Definition at line 66 of file handlers.hpp.

Member Function Documentation

virtual const char* ecl::Error::argNotSupportedErrorString ( ) const

inlineprotectedvirtual

Definition at line 156 of file handlers.hpp.

virtual const char* ecl::Error::blockingErrorString ( ) const

inlineprotectedvirtual

Definition at line 161 of file handlers.hpp.

virtual const char* ecl::Error::busyErrorString ( ) const

inlineprotectedvirtual

Definition at line 158 of file handlers.hpp.

virtual const char* ecl::Error::closeErrorString ( ) const

inlineprotectedvirtual

Definition at line 145 of file handlers.hpp.

virtual const char* ecl::Error::configurationErrorString ( ) const

inlineprotectedvirtual

Definition at line 147 of file handlers.hpp.

virtual const char* ecl::Error::connectErrorString ( ) const

inlineprotectedvirtual

Definition at line 148 of file handlers.hpp.

virtual const char* ecl::Error::connectionRefusedString ( ) const

inlineprotectedvirtual

Definition at line 167 of file handlers.hpp.

virtual const char* ecl::Error::constructorErrorString ( ) const

inlineprotectedvirtual

Definition at line 141 of file handlers.hpp.

virtual const char* ecl::Error::conversionErrorString ( ) const

inlineprotectedvirtual

Definition at line 143 of file handlers.hpp.

virtual const char* ecl::Error::destructorErrorString ( ) const

inlineprotectedvirtual

Definition at line 142 of file handlers.hpp.

virtual ErrorFlag ecl::Error::flag ( ) const

inlinevirtual

The flag identifying the error identified with this error handler.

Returns

ErrorFlag : the error flag.

Definition at line 72 of file handlers.hpp.

virtual const char* ecl::Error::interruptedErrorString ( ) const

inlineprotectedvirtual

Definition at line 160 of file handlers.hpp.

virtual const char* ecl::Error::invalidArgErrorString ( ) const

inlineprotectedvirtual

Definition at line 146 of file handlers.hpp.

virtual const char* ecl::Error::invalidObjectErrorString ( ) const

inlineprotectedvirtual

Definition at line 163 of file handlers.hpp.

virtual const char* ecl::Error::isLockedErrorString ( ) const

inlineprotectedvirtual

Definition at line 164 of file handlers.hpp.

virtual const char* ecl::Error::isTimeOutErrorString ( ) const

inlineprotectedvirtual

Definition at line 165 of file handlers.hpp.

virtual const char* ecl::Error::memoryErrorString ( ) const

inlineprotectedvirtual

Definition at line 153 of file handlers.hpp.

virtual const char* ecl::Error::noErrorString ( ) const

inlineprotectedvirtual

Definition at line 139 of file handlers.hpp.

virtual const char* ecl::Error::notFoundErrorString ( ) const

inlineprotectedvirtual

Definition at line 166 of file handlers.hpp.

virtual const char* ecl::Error::notInitialisedErrorString ( ) const

inlineprotectedvirtual

Definition at line 151 of file handlers.hpp.

virtual const char* ecl::Error::notSupportedErrorString ( ) const

inlineprotectedvirtual

Definition at line 157 of file handlers.hpp.

virtual const char* ecl::Error::openErrorString ( ) const

inlineprotectedvirtual

Definition at line 144 of file handlers.hpp.

virtual void ecl::Error::operator= ( const ErrorFlag &  error )

inlinevirtual

Definition at line 73 of file handlers.hpp.

virtual const char* ecl::Error::outOfRangeErrorString ( ) const

inlineprotectedvirtual

Definition at line 140 of file handlers.hpp.

virtual const char* ecl::Error::outOfResourcesErrorString ( ) const

inlineprotectedvirtual

Definition at line 159 of file handlers.hpp.

virtual const char* ecl::Error::permissionsErrorString ( ) const

inlineprotectedvirtual

Definition at line 152 of file handlers.hpp.

virtual void ecl::Error::print ( const char *  loc )

inlinevirtual

Print a location dependent message to standard out.

Usage:

Error error = f(5);
if ( error.flag() != NoError ) {
    error.print(LOC);
}

Parameters

loc	: use with the LOC macro.

Definition at line 94 of file handlers.hpp.

virtual const char* ecl::Error::raiiErrorString ( ) const

inlineprotectedvirtual

Definition at line 155 of file handlers.hpp.

virtual const char* ecl::Error::readErrorString ( ) const

inlineprotectedvirtual

Definition at line 149 of file handlers.hpp.

virtual const char* ecl::Error::systemFailureErrorString ( ) const

inlineprotectedvirtual

Definition at line 162 of file handlers.hpp.

virtual const char* ecl::Error::unknownErrorString ( ) const

inlineprotectedvirtual

Definition at line 168 of file handlers.hpp.

virtual const char* ecl::Error::usageErrorString ( ) const

inlineprotectedvirtual

Definition at line 154 of file handlers.hpp.

virtual const char* ecl::Error::what ( ) const

inlinevirtual

A simple string verbosely representing the error that is handled.

Returns

const char* : verbose representation of the error.

Definition at line 103 of file handlers.hpp.

virtual const char* ecl::Error::writeErrorString ( ) const

inlineprotectedvirtual

Definition at line 150 of file handlers.hpp.

Member Data Documentation

ErrorFlag ecl::Error::error_flag

protected

Definition at line 170 of file handlers.hpp.

---

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

• handlers.hpp