Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_UnitTestBase.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_UNIT_TEST_BASE_HPP
43#define TEUCHOS_UNIT_TEST_BASE_HPP
44
45
51#include "Teuchos_Describable.hpp"
52#include "Teuchos_FancyOStream.hpp"
53
54
55namespace Teuchos {
56
57
59class TEUCHOSCORE_LIB_DLL_EXPORT UnitTestBase : public Describable {
60public:
61
63 UnitTestBase(const std::string groupName, std::string testName);
64
66 bool runUnitTest(FancyOStream &out) const;
67
69 virtual std::string unitTestFile() const = 0;
70
72 virtual long int unitTestFileLineNumber() const = 0;
73
74protected:
75
77 virtual void runUnitTestImpl(FancyOStream &out, bool &success) const = 0;
78
79};
80
81
82} // namespace Teuchos
83
84
85#endif // TEUCHOS_UNIT_TEST_BASE_HPP
Base class for all objects that can describe themselves.
Smart reference counting pointer class for automatic garbage collection.
Unit test base class.
virtual void runUnitTestImpl(FancyOStream &out, bool &success) const =0
virtual long int unitTestFileLineNumber() const =0
virtual std::string unitTestFile() const =0
std::ostream subclass that performs the magic of indenting data sent to an std::ostream object among ...
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...