OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESError Class Reference

Abstract exception class for the BES with basic string message. More...

#include <BESError.h>

Inheritance diagram for BESError:
Inheritance graph
Collaboration diagram for BESError:
Collaboration graph

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 More...
 
virtual void dump (ostream &strm) const
 Displays debug information about this object. More...
 
virtual int get_error_type ()
 Return the return code for this error class. More...
 
virtual string get_file ()
 get the file name where the exception was thrown More...
 
virtual int get_line ()
 get the line number where the exception was thrown More...
 
virtual string get_message ()
 get the error message for this exception More...
 
virtual void set_error_type (int type)
 Set the return code for this particular error class. More...
 
virtual void set_message (const string &msg)
 set the error message for this exception More...
 
virtual ~BESError ()
 

Protected Member Functions

 BESError ()
 

Protected Attributes

string _file
 
unsigned int _line
 
string _msg
 
unsigned int _type
 

Detailed Description

Abstract exception class for the BES with basic string message.

Definition at line 51 of file BESError.h.

Constructor & Destructor Documentation

BESError::BESError ( )
inlineprotected

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

Parameters
msgerror message
typetype 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.
filethe filename in which this error object was created
linethe line number within the file in which this error object was created

Definition at line 72 of file BESError.h.

virtual BESError::~BESError ( )
inlinevirtual

Definition at line 80 of file BESError.h.

Member Function Documentation

void BESError::dump ( ostream &  strm) const
virtual

Displays debug information about this object.

dumps information about this object

Parameters
strmoutput 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.

Parameters
strmC++ i/o stream to dump the information to

Implements BESObj.

Reimplemented in BESDapError, BESInternalFatalError, BESSyntaxUserError, BESForbiddenError, BESInternalError, and BESNotFoundError.

Definition at line 44 of file BESError.cc.

References _file, _line, _msg, _type, BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Referenced by BESForbiddenError::dump(), BESNotFoundError::dump(), BESInternalError::dump(), BESSyntaxUserError::dump(), BESInternalFatalError::dump(), and BESDapError::dump().

Here is the call graph for this function:

virtual int BESError::get_error_type ( )
inlinevirtual

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

Returns
context string

Definition at line 120 of file BESError.h.

References _type.

Referenced by BESInfo::add_exception(), BESApacheInterface::exception_manager(), DaemonCommandHandler::handle(), BESExceptionManager::handle_exception(), and BESDapError::handleException().

virtual string BESError::get_file ( )
inlinevirtual

get the file name where the exception was thrown

Returns
file name

Definition at line 96 of file BESError.h.

References _file.

Referenced by BESInfo::add_exception().

virtual int BESError::get_line ( )
inlinevirtual

get the line number where the exception was thrown

Returns
line number

Definition at line 101 of file BESError.h.

References _line.

Referenced by BESInfo::add_exception().

virtual void BESError::set_error_type ( int  type)
inlinevirtual

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.

Parameters
typethe 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::handleException(), and BESApacheInterface::validate_data_request().

virtual void BESError::set_message ( const string &  msg)
inlinevirtual

set the error message for this exception

Parameters
msgmessage string

Definition at line 86 of file BESError.h.

References _msg.

Referenced by BESDapError::handleException().

Member Data Documentation

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().


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