BESMemoryException Class Reference

#include <BESMemoryException.h>

Inheritance diagram for BESMemoryException:

Inheritance graph
[legend]
Collaboration diagram for BESMemoryException:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BESMemoryException (const string &msg, const string &file, int line)
virtual ~BESMemoryException ()
virtual void set_message (const string &msg)
 set the error message for this exception
virtual string get_message ()
 get the error message for this exception
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 void set_context (const string &context)
 Set the context name of the error class.
virtual string get_context ()
 Return the context name of the error class.
virtual void set_return_code (int return_code)
 Set the return code for this particular error class.
virtual int get_return_code ()
 Return the return code for this error class.
virtual void dump (ostream &strm) const
 Displays debug information about this object.

Protected Member Functions

 BESMemoryException ()

Protected Attributes

string _msg
string _context
int _return_code
string _file
int _line

Detailed Description

Definition at line 38 of file BESMemoryException.h.


Constructor & Destructor Documentation

BESMemoryException::BESMemoryException (  )  [inline, protected]

Definition at line 41 of file BESMemoryException.h.

BESMemoryException::BESMemoryException ( const string &  msg,
const string &  file,
int  line 
) [inline]

Definition at line 43 of file BESMemoryException.h.

References BES_MEMORY_EXCEPTION, BESException::set_context(), and BESException::set_return_code().

Here is the call graph for this function:

virtual BESMemoryException::~BESMemoryException (  )  [inline, virtual]

Definition at line 51 of file BESMemoryException.h.


Member Function Documentation

virtual void BESException::set_message ( const string &  msg  )  [inline, virtual, inherited]

set the error message for this exception

Parameters:
s message string

Definition at line 70 of file BESException.h.

References BESException::_msg.

Referenced by BESDapHandlerException::handleException().

virtual string BESException::get_message (  )  [inline, virtual, inherited]

get the error message for this exception

Returns:
error message

Definition at line 75 of file BESException.h.

References BESException::_msg.

Referenced by BESInfo::add_exception(), BESCatalogDirectory::BESCatalogDirectory(), BESContainerStorageCatalog::BESContainerStorageCatalog(), BESMemoryGlobalArea::BESMemoryGlobalArea(), BESApacheInterface::exception_manager(), BESDapHandlerException::handleException(), BESModuleApp::initialize(), BESBaseApp::initialize(), baseApp::initialize(), main(), uncompressT::run(), pvolT::run(), pfileT::run(), lockT::run(), keysT::run(), gzT::run(), containerT::run(), cacheT::run(), bz2T::run(), agglistT::run(), and BESModuleApp::terminate().

virtual string BESException::get_file (  )  [inline, virtual, inherited]

get the file name where the exception was thrown

Returns:
file name

Definition at line 80 of file BESException.h.

References BESException::_file.

Referenced by BESInfo::add_exception(), BESCatalogDirectory::BESCatalogDirectory(), and BESContainerStorageCatalog::BESContainerStorageCatalog().

virtual int BESException::get_line (  )  [inline, virtual, inherited]

get the line number where the exception was thrown

Returns:
line number

Definition at line 85 of file BESException.h.

References BESException::_line.

Referenced by BESInfo::add_exception(), BESCatalogDirectory::BESCatalogDirectory(), and BESContainerStorageCatalog::BESContainerStorageCatalog().

virtual void BESException::set_context ( const string &  context  )  [inline, virtual, inherited]

Set the context name of the error class.

Gives the error context, such as response or request or transmit

Parameters:
context name of the context

Definition at line 92 of file BESException.h.

References BESException::_context.

Referenced by BESAggregationException::BESAggregationException(), BESContainerStorageException::BESContainerStorageException(), BESDatabaseException::BESDatabaseException(), BESHandlerException::BESHandlerException(), BESIncorrectRequestException::BESIncorrectRequestException(), BESKeysException::BESKeysException(), BESLogException::BESLogException(), BESMemoryException(), BESParserException::BESParserException(), BESResponseException::BESResponseException(), BESTransmitException::BESTransmitException(), and TestException::TestException().

virtual string BESException::get_context (  )  [inline, virtual, inherited]

Return the context name of the error class.

Gives the error context, such as response or request or transmit

Returns:
context string

Definition at line 102 of file BESException.h.

References BESException::_context.

Referenced by BESInfo::add_exception().

virtual void BESException::set_return_code ( int  return_code  )  [inline, virtual, inherited]

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:
return_code code used when returning from the error

Definition at line 110 of file BESException.h.

References BESException::_return_code.

Referenced by BESAggregationException::BESAggregationException(), BESContainerStorageException::BESContainerStorageException(), BESDatabaseException::BESDatabaseException(), BESHandlerException::BESHandlerException(), BESIncorrectRequestException::BESIncorrectRequestException(), BESKeysException::BESKeysException(), BESLogException::BESLogException(), BESMemoryException(), BESParserException::BESParserException(), BESResponseException::BESResponseException(), BESTransmitException::BESTransmitException(), and TestException::TestException().

virtual int BESException::get_return_code (  )  [inline, virtual, inherited]

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 121 of file BESException.h.

References BESException::_return_code.

Referenced by BESExceptionManager::handle_exception(), and BESDapHandlerException::handleException().

void BESException::dump ( ostream &  strm  )  const [virtual, inherited]

Displays debug information about this object.

Parameters:
strm output stream to use to dump the contents of this object

Implements BESObj.

Reimplemented in BESContainerStorageException.

Definition at line 44 of file BESException.cc.

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

Referenced by BESContainerStorageException::dump().

Here is the call graph for this function:


Member Data Documentation

string BESException::_msg [protected, inherited]

Definition at line 49 of file BESException.h.

Referenced by BESException::BESException(), BESException::dump(), BESException::get_message(), and BESException::set_message().

string BESException::_context [protected, inherited]

Definition at line 50 of file BESException.h.

Referenced by BESException::get_context(), and BESException::set_context().

int BESException::_return_code [protected, inherited]

Definition at line 51 of file BESException.h.

Referenced by BESException::get_return_code(), and BESException::set_return_code().

string BESException::_file [protected, inherited]

Definition at line 52 of file BESException.h.

Referenced by BESException::dump(), and BESException::get_file().

int BESException::_line [protected, inherited]

Definition at line 53 of file BESException.h.

Referenced by BESException::dump(), and BESException::get_line().


The documentation for this class was generated from the following file:
Generated on Wed Aug 29 03:24:02 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.5.2