vrj::test::TestFailure Class Reference

This is the exception that is thrown when a test fails. More...

#include <vrj/Test/TestFailure.h>

Collaboration diagram for vrj::test::TestFailure:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TestFailure (Test *failedTest, vrj::test::Message message, const std::string &fileName, int lineNumber) throw ()
virtual ~TestFailure () throw ()
TestgetFailedTest ()
std::string getFailedTestName ()
vrj::test::Message getMessage () const
std::string getFileName () const
int getLineNumber () const
std::string getFullDescription ()

Protected Attributes

TestmFailedTest
 The test that failed.
vrj::test::Message mMessage
 Message describing the failure.
std::string mFileName
 Filename where it occured.
int mLineNumber
 The line number it happened on.

Detailed Description

This is the exception that is thrown when a test fails.

It contains enough information to give a description of what failed and to track this a little bit.

These are collected to track the failed tests.

Definition at line 63 of file TestFailure.h.


Constructor & Destructor Documentation

vrj::test::TestFailure::TestFailure ( Test failedTest,
vrj::test::Message  message,
const std::string &  fileName,
int  lineNumber 
) throw () [inline]

Definition at line 66 of file TestFailure.h.

00069       : mFailedTest(failedTest)
00070       , mMessage(message)
00071       , mFileName(fileName)
00072       , mLineNumber(lineNumber)
00073    {
00074 
00075    }

virtual vrj::test::TestFailure::~TestFailure (  )  throw () [inline, virtual]

Definition at line 77 of file TestFailure.h.

00078    {;}


Member Function Documentation

Test* vrj::test::TestFailure::getFailedTest (  )  [inline]

Definition at line 80 of file TestFailure.h.

References mFailedTest.

00081    {
00082       return mFailedTest;
00083    }

std::string vrj::test::TestFailure::getFailedTestName (  )  [inline]

Definition at line 85 of file TestFailure.h.

References vrj::test::Test::getName(), and mFailedTest.

Referenced by getFullDescription().

00086    {
00087       return mFailedTest->getName();
00088    }

vrj::test::Message vrj::test::TestFailure::getMessage (  )  const [inline]

Definition at line 90 of file TestFailure.h.

References mMessage.

Referenced by getFullDescription().

00091    {
00092       return mMessage;
00093    }

std::string vrj::test::TestFailure::getFileName (  )  const [inline]

Definition at line 95 of file TestFailure.h.

References mFileName.

Referenced by getFullDescription().

00096    {
00097       return mFileName;
00098    }

int vrj::test::TestFailure::getLineNumber (  )  const [inline]

Definition at line 100 of file TestFailure.h.

References mLineNumber.

Referenced by getFullDescription().

00101    {
00102       return mLineNumber;
00103    }

std::string vrj::test::TestFailure::getFullDescription (  )  [inline]

Definition at line 105 of file TestFailure.h.

References vrj::test::Message::details(), getFailedTestName(), getFileName(), getLineNumber(), getMessage(), mFailedTest, and vrj::test::Message::shortDesc().

00106    {
00107       vprASSERT(NULL != mFailedTest);
00108 
00109       std::stringstream oss;
00110       oss << getFailedTestName() << ": ";
00111       oss << getFileName() << ": line:";
00112       oss << getLineNumber() << ": ";
00113       oss << getMessage().shortDesc();
00114       oss << "\n" << getMessage().details();
00115       return oss.str();
00116    }


Member Data Documentation

Test* vrj::test::TestFailure::mFailedTest [protected]

The test that failed.

Definition at line 120 of file TestFailure.h.

Referenced by getFailedTest(), getFailedTestName(), and getFullDescription().

vrj::test::Message vrj::test::TestFailure::mMessage [protected]

Message describing the failure.

Definition at line 121 of file TestFailure.h.

Referenced by getMessage().

std::string vrj::test::TestFailure::mFileName [protected]

Filename where it occured.

Definition at line 122 of file TestFailure.h.

Referenced by getFileName().

int vrj::test::TestFailure::mLineNumber [protected]

The line number it happened on.

Definition at line 123 of file TestFailure.h.

Referenced by getLineNumber().


The documentation for this class was generated from the following file:
Generated on Thu Jan 4 10:58:34 2007 for VR Juggler by  doxygen 1.5.1