Abstract exception class for the BES with basic string message. More...
#include <BESError.h>
Public Member Functions | |
BESError (const string &msg, unsigned int type, const string &file, unsigned int line) | |
constructor that takes message, type of error, source file the error originated and the line number in the source file | |
virtual void | dump (ostream &strm) const |
Displays debug information about this object. | |
virtual int | get_error_type () |
Return the return code for this error class. | |
virtual string | get_file () |
get the file name where the exception was thrown | |
virtual int | get_line () |
get the line number where the exception was thrown | |
virtual string | get_message () |
get the error message for this exception | |
virtual void | set_error_type (int type) |
Set the return code for this particular error class. | |
virtual void | set_message (const string &msg) |
set the error message for this exception | |
virtual | ~BESError () |
Protected Member Functions | |
BESError () | |
Protected Attributes | |
string | _file |
unsigned int | _line |
string | _msg |
unsigned int | _type |
Abstract exception class for the BES with basic string message.
Definition at line 51 of file BESError.h.
BESError::BESError | ( | ) | [inline, protected] |
Definition at line 59 of file BESError.h.
References _msg.
BESError::BESError | ( | const string & | msg, | |
unsigned int | type, | |||
const string & | file, | |||
unsigned int | line | |||
) | [inline] |
constructor that takes message, type of error, source file the error originated and the line number in the source file
msg | error message | |
type | type of error generated. Default list of error types are defined above as internal error, internal fatal error, syntax/user error, resource forbidden error, resource not found error. | |
file | the filename in which this error object was created | |
line | the line number within the file in which this error object was created |
Definition at line 72 of file BESError.h.
virtual BESError::~BESError | ( | ) | [inline, virtual] |
Definition at line 80 of file BESError.h.
void BESError::dump | ( | ostream & | strm | ) | const [virtual] |
Displays debug information about this object.
dumps information about this object
strm | output stream to use to dump the contents of this object |
Displays the pointer value of this instance along with the exception message, the file from which the exception was generated, and the line number in that file.
strm | C++ i/o stream to dump the information to |
Implements BESObj.
Reimplemented in BESDapError, BESForbiddenError, BESInternalError, BESInternalFatalError, BESNotFoundError, and BESSyntaxUserError.
Definition at line 44 of file BESError.cc.
References _file, _line, _msg, _type, BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
virtual int BESError::get_error_type | ( | ) | [inline, virtual] |
Return the return code for this error class.
Returns the return code for this error class, which could represent the need to terminate or do something specific base on the error
Definition at line 120 of file BESError.h.
References _type.
Referenced by BESInfo::add_exception(), BESApacheInterface::exception_manager(), BESExceptionManager::handle_exception(), and BESDapError::handleException().
virtual string BESError::get_file | ( | ) | [inline, virtual] |
get the file name where the exception was thrown
Definition at line 96 of file BESError.h.
References _file.
Referenced by BESInfo::add_exception().
virtual int BESError::get_line | ( | ) | [inline, virtual] |
get the line number where the exception was thrown
Definition at line 101 of file BESError.h.
References _line.
Referenced by BESInfo::add_exception().
virtual string BESError::get_message | ( | ) | [inline, virtual] |
get the error message for this exception
Definition at line 91 of file BESError.h.
References _msg.
Referenced by BESInfo::add_exception(), BESMemoryGlobalArea::BESMemoryGlobalArea(), BESServerHandler::BESServerHandler(), PPTClient::closeConnection(), BESApacheInterface::exception_manager(), BESInterface::finish(), BESDapError::handleException(), PPTClient::initConnection(), StandAloneApp::initialize(), ServerApp::initialize(), BESModuleApp::initialize(), BESBaseApp::initialize(), main(), StandAloneApp::run(), ServerApp::run(), CmdApp::run(), BESModuleApp::terminate(), and CmdTranslation::translate().
virtual void BESError::set_error_type | ( | int | type | ) | [inline, virtual] |
Set the return code for this particular error class.
Sets the return code for this error class, which could represent the need to terminate or do something specific based on the error.
type | the type of error this error object represents. Can be one of BES_INTERNAL_ERROR, BES_INTERNAL_FATAL_ERROR, BES_SYNTAX_USER_ERROR, BES_FORBIDDEN_ERROR, BES_NOT_FOUND_ERROR |
Definition at line 112 of file BESError.h.
References _type.
Referenced by BESDapError::BESDapError(), BESDapError::handleException(), and BESApacheInterface::validate_data_request().
virtual void BESError::set_message | ( | const string & | msg | ) | [inline, virtual] |
set the error message for this exception
msg | message string |
Definition at line 86 of file BESError.h.
References _msg.
Referenced by BESDapError::handleException().
string BESError::_file [protected] |
Definition at line 56 of file BESError.h.
Referenced by dump(), and get_file().
unsigned int BESError::_line [protected] |
Definition at line 57 of file BESError.h.
Referenced by dump(), and get_line().
string BESError::_msg [protected] |
Definition at line 54 of file BESError.h.
Referenced by BESError(), dump(), get_message(), and set_message().
unsigned int BESError::_type [protected] |
Definition at line 55 of file BESError.h.
Referenced by dump(), get_error_type(), and set_error_type().