---

mpcl::TException Class Reference

#include <exception.hh>

Inheritance diagram for mpcl::TException:

List of all members.

Public Methods
	TException (void)
	TException (const string &rkySYNOPSYS, const string &rkyRATIONALE=string(), const string &rkyFILE_NAME=string(), const int kiLINE_NUMBER=0)
	TException (const TException &rktSOURCE_EXCEPTION)
const string &	generalDescription (void) const throw ()
const string &	specificDescription (void) const throw ()
const string &	fileName (void) const throw ()
int	lineNumber (void) const throw ()
virtual const string	what (void) const
Protected Methods
void	write (basic_ostream< char_type, traits_type > &rtOUTPUT_OSTREAM) const
Protected Attributes
string	ySynopsis
	General description of the exception.
string	yRationale
	Specific description of the exception.
string	yFileName
	File name where the exception has its meaning.
int	iLineNumber
	Line-number in the former file name.

---

Detailed Description

Exception: exception class.

Warning:

The order of inheritance from exception classes, has special significance due to the next fact: the constructor of base classes inherited of "virtual" fashion, are called only once.

Warning:

It uses the class 'std::string' to remove loop dependencies.

Definition at line 50 of file exception.hh.

---

Constructor & Destructor Documentation

mpcl::TException::TException (  void    )  [inline]

Builds the instance without any kind of descriptions of the exception. Definition at line 78 of file exception.hh. References iLineNumber, yFileName, yRationale, and ySynopsis.

mpcl::TException::TException (  const string &    rkySYNOPSYS, const string &    rkyRATIONALE = string(), const string &    rkyFILE_NAME = string(), const int    kiLINE_NUMBER = 0 )  [inline]

Builds the instance with a general description and (if passed) a specific description. Parameters: rkySYNOPSYS  General exception description. rkyRATIONALE  Specific exception description. rkyFILE_NAME  File name where the exception throws. kiLINE_NUMBER  Line number from that file. Definition at line 93 of file exception.hh. References iLineNumber, yFileName, yRationale, and ySynopsis.

mpcl::TException::TException (  const TException &    rktSOURCE_EXCEPTION )  [inline]

Builds the instance as a copy of the instance rktSOURCE_EXCEPTION. Parameters: rktSOURCE_EXCEPTION  Source instance. Definition at line 108 of file exception.hh. References iLineNumber, yFileName, yRationale, and ySynopsis.

---

Member Function Documentation

const string& mpcl::TException::fileName (  void    )  const throw () [inline]

Gets the file name where the exception was thrown. Returns: File name where the exception was thrown. Definition at line 144 of file exception.hh. References yFileName.

const string& mpcl::TException::generalDescription (  void    )  const throw () [inline]

Gets a general description of the exception. Returns: General description of the exception. Definition at line 126 of file exception.hh. References ySynopsis.

int mpcl::TException::lineNumber (  void    )  const throw () [inline]

Gets a line number of the exception. Returns: Specific description of the exception. Definition at line 153 of file exception.hh. References iLineNumber.

const string& mpcl::TException::specificDescription (  void    )  const throw () [inline]

Gets a specific description of the exception. Returns: Specific description of the exception. Definition at line 135 of file exception.hh. References yRationale.

const std::string mpcl::TException::what (  void    )  const [virtual]

Gets a description of the exception. Returns: Description of the exception. Definition at line 34 of file exception.cc. References iLineNumber, yFileName, yRationale, and ySynopsis. Referenced by write().

void mpcl::TException::write (  basic_ostream< char_type, traits_type > &    rtOUTPUT_OSTREAM )  const [inline, protected, virtual]

Put onto stream rtTARGET_OSTREAM a formatted string with information about this exception. Implements mpcl::io::IOutputStreamable< TChar, TTraits >. Definition at line 175 of file exception.hh. References what().

---

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

• exception.hh
• exception.cc

---