bes  Updated for version 3.20.6
BESError Class Reference

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

#include <BESError.h>

Collaboration diagram for BESError:
Collaboration graph

Public Member Functions

 BESError (const std::string &msg, unsigned int type, const std::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 (std::ostream &strm) const
 Displays debug information about this object. More...
 
virtual int get_bes_error_type ()
 Return the return code for this error class. More...
 
virtual std::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 std::string get_message ()
 get the error message for this exception More...
 
virtual std::string get_verbose_message ()
 
virtual void set_bes_error_type (int type)
 Set the return code for this particular error class. More...
 
virtual void set_message (const std::string &msg)
 set the error message for this exception More...
 

Protected Attributes

std::string _file
 
unsigned int _line
 
std::string _msg
 
unsigned int _type
 

Detailed Description

Abstract exception class for the BES with basic string message.

Definition at line 58 of file BESError.h.

Constructor & Destructor Documentation

◆ BESError()

BESError::BESError ( const std::string &  msg,
unsigned int  type,
const std::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 79 of file BESError.h.

Member Function Documentation

◆ dump()

void BESError::dump ( std::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 BESInternalError, BESInternalFatalError, BESSyntaxUserError, BESForbiddenError, BESNotFoundError, and cmr::CmrError.

Definition at line 59 of file BESError.cc.

◆ get_bes_error_type()

virtual int BESError::get_bes_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 143 of file BESError.h.

◆ get_file()

virtual std::string BESError::get_file ( )
inlinevirtual

get the file name where the exception was thrown

Returns
file name

Definition at line 107 of file BESError.h.

◆ get_line()

virtual int BESError::get_line ( )
inlinevirtual

get the line number where the exception was thrown

Returns
line number

Definition at line 115 of file BESError.h.

◆ get_message()

virtual std::string BESError::get_message ( )
inlinevirtual

get the error message for this exception

Returns
error message

Definition at line 99 of file BESError.h.

◆ set_bes_error_type()

virtual void BESError::set_bes_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 132 of file BESError.h.

◆ set_message()

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

set the error message for this exception

Parameters
msgmessage string

Definition at line 91 of file BESError.h.


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