CoreLinux++  0.4.32
Public Member Functions | Protected Member Functions | List of all members
corelinux::IteratorException Class Reference

IteratorException is the base exception type for Iterator. More...

#include <IteratorException.hpp>

Public Member Functions

 IteratorException (CharCptr file, LineNum line, Severity severity=Exception::CONTINUABLE, bool outOfMemory=false)
 Default Constructor. More...
 
 IteratorException (IteratorExceptionCref)
 Copy constructor. More...
 
virtual ~IteratorException (void)
 Virtual Destructor.
 
IteratorExceptionRef operator= (IteratorExceptionCref)
 Assignment operator overload. More...
 
bool operator== (IteratorExceptionCref) const
 Equality operator overload. More...
 
- Public Member Functions inherited from corelinux::Exception
 Exception (CharCptr why, CharCptr file, LineNum line, Severity severity=Exception::CONTINUABLE, bool outOfMemory=false)
 Default Constructor. More...
 
 Exception (ExceptionCref crOther)
 Copy constructor. More...
 
virtual ~Exception (void)
 Virtual Destructor.
 
ExceptionRef operator= (ExceptionCref otherRef)
 Assignment operator overload. More...
 
bool operator== (ExceptionCref otherRef)
 Comparisson operator overload. More...
 
const std::string & getFile (void) const
 Accessor. More...
 
LineNumCref getLine (void) const
 Accessor. More...
 
const std::string & getWhy (void) const
 Accessor. More...
 
const SeveritygetSeverity (void) const
 Accessor. More...
 
const std::string & getUnwind (void) const
 Accessor. More...
 
bool isOutOfMemory (void) const
 Accessor. More...
 
void addUnwindInfo (CharCptr unwindInfo)
 Append unwind information to the Exception. More...
 
void setThreadFatalSeverity (void)
 Change the severity to Severity::THREADFATAL.
 
void setProcessFatalSeverity (void)
 Change the severity to Severity::PROCESSFATAL.
 
void setThreadTerminateSeverity (void)
 Change the severity to Severity::THREADTERMINATE. More...
 
void setProcessTerminateSeverity (void)
 Change the severity to Severity::PROCESSTERMINATE. More...
 

Protected Member Functions

 IteratorException (CharCptr why, CharCptr file, LineNum line, Severity severity=Exception::CONTINUABLE, bool outOfMemory=false)
 Default Constructor. More...
 
 IteratorException (void)
 IteratorException must have at least a location. More...
 
- Protected Member Functions inherited from corelinux::Exception
 Exception (void)
 Exceptions must have a reason. More...
 
 Exception (CharCptr file, LineNum line, Severity severity=Exception::CONTINUABLE, bool outOfMemory=false)
 Exception constructor for use by derivations.
 
void setWhy (const std::string &)
 Changes the exception reason.
 
void setWhy (CharCptr)
 Changes the exception reason.
 

Additional Inherited Members

- Public Types inherited from corelinux::Exception
enum  Severity {
  CONTINUABLE = 1, THREADFATAL, PROCESSFATAL, THREADTERMINATE,
  PROCESSTERMINATE
}
 Exception Severity States. More...
 

Detailed Description

IteratorException is the base exception type for Iterator.

All Iterator exceptions derive from this.

Constructor & Destructor Documentation

corelinux::IteratorException::IteratorException ( CharCptr  file,
LineNum  line,
Severity  severity = Exception::CONTINUABLE,
bool  outOfMemory = false 
)

Default Constructor.

Parameters
fileThe source module throwing the exception
lineThe line of source throwing the exception
severityThe Exception::Severity of the Exception
outOfMemoryAn out of memory indicator

References IteratorException().

corelinux::IteratorException::IteratorException ( IteratorExceptionCref  aRef)

Copy constructor.

Parameters
IteratorExceptionconst reference
corelinux::IteratorException::IteratorException ( CharCptr  why,
CharCptr  file,
LineNum  line,
Severity  severity = Exception::CONTINUABLE,
bool  outOfMemory = false 
)
protected

Default Constructor.

Parameters
whydescribes why the exception was thrown
fileThe source module throwing the exception
lineThe line of source throwing the exception
severityThe Exception::Severity of the Exception
outOfMemoryAn out of memory indicator
corelinux::IteratorException::IteratorException ( void  )
protected

IteratorException must have at least a location.

Default constructor is not allowed.

Referenced by IteratorException().

Member Function Documentation

IteratorExceptionRef corelinux::IteratorException::operator= ( IteratorExceptionCref  aRef)

Assignment operator overload.

Parameters
IteratorExceptionconst reference
Returns
IteratorException reference to self

References corelinux::Exception::operator=().

Referenced by corelinux::IteratorBoundsException::operator=(), and corelinux::InvalidIteratorException::operator=().

bool corelinux::IteratorException::operator== ( IteratorExceptionCref  aRef) const

Equality operator overload.

Parameters
IteratorExceptionconst reference
Returns
true if equal, false otherwise

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

This is the CoreLinux++ reference manual
Provided by The CoreLinux Consortium