ppf::ppf_error Class Reference

PPF system exception class. More...

#include <ppftypes.hpp>

List of all members.

Public Member Functions

 ppf_error ()
 Basic Constructor.
 ppf_error (string errormsg)
 Initialising constructor.
 ppf_error (string name, int value)
 Initialising constructor.
 ppf_error (string name, int value, string errormsg)
 Initialising constructor.

Public Attributes

const int code
 Holds the PPF system error code.
const string method
 Holds the name of PPF method which failed.
const string message
 Holds a decriptive error message.


Detailed Description

PPF system exception class.

Thrown when an error occurs in the PPF system.


Constructor & Destructor Documentation

ppf::ppf_error::ppf_error ( string  errormsg  )  [inline]

Initialising constructor.

Sets error message to passed string. PPF routine and error code are set to null.

Parameters:
errormsg String containing the error message.

ppf::ppf_error::ppf_error ( string  name,
int  value 
) [inline]

Initialising constructor.

Sets PPF routine and error code to passed values. Sets message to a default error message.

Parameters:
name String containing name of PPF routine which failed.
value Integer containing error code returned by failed PPF routine.

ppf::ppf_error::ppf_error ( string  name,
int  value,
string  errormsg 
) [inline]

Initialising constructor.

Sets failed ppf routine name, code and error message to passed values.

Parameters:
name String containing name of PPF routine which failed.
value Integer containing error code returned by failed PPF routine.
errormsg String containing the error message.


The documentation for this class was generated from the following file:
Generated on Tue Apr 8 16:45:13 2008 for PPF C++ by  doxygen 1.5.1