KardsGTError Class Reference

#include <kardsgterror.h>

Inheritance diagram for KardsGTError:

Inheritance graph
[legend]
Collaboration diagram for KardsGTError:

Collaboration graph
[legend]

List of all members.


Detailed Description

This is the catch all run time error handling class for KardsGT.

Author:
John Schneiderman

Public Member Functions

QString classMethod () const
QString className () const
QString errorMessage () const
 KardsGTError (const KardsGTError &kardsGTError)
 KardsGTError (QString name, QString method, QString message)
 KardsGTError (const char *name, const char *method, const char *message)
bool operator== (const KardsGTError &error) const
 ~KardsGTError () throw ()

Friends

ostream & operator<< (ostream &out, const KardsGTError &error)

Constructor & Destructor Documentation

KardsGTError::KardsGTError ( const char *  name,
const char *  method,
const char *  message 
)

Default constructor

Parameters:
name is the name of the class generating the error.
method is the name of the method generating the error.
message is the message explaining what cause the error.

KardsGTError::KardsGTError ( QString  name,
QString  method,
QString  message 
)

Default constructor

Parameters:
name is the name of the class generating the error.
method is the name of the method generating the error.
message is the message explaining what cause the error.

KardsGTError::KardsGTError ( const KardsGTError kardsGTError  ) 

Copy constructor

Parameters:
kardsGTError is the what to copy into *this.

KardsGTError::~KardsGTError (  )  throw ()

Destructor


Member Function Documentation

QString KardsGTError::classMethod (  )  const

Gives the name of the method the caused the exception.

Returns:
the name of the method in the class.

QString KardsGTError::className (  )  const

Gives the name of the offending class.

Returns:
the name of the class that generated the exception.

QString KardsGTError::errorMessage (  )  const

Gives the error message.

Returns:
the error message that caused the exception.

bool KardsGTError::operator== ( const KardsGTError error  )  const

Equality operator.

Note:
Mostly used for testing the class.
Parameters:
error this is the error to test.
Returns:
true if class name, method name and error message are all the same.


Friends And Related Function Documentation

ostream& operator<< ( ostream &  out,
const KardsGTError error 
) [friend]

Stream insertion operator to display the thrown error.

Parameters:
out is the buffer to write the error message to in the form of: class, method: errormessage.
error is the error thrown.
Returns:
out.


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

Generated on Tue Aug 12 23:24:02 2008 for KardsGT by  doxygen 1.5.5