Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_Object.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 // Kris
43 // 07.08.03 -- Move into Teuchos package/namespace
44 
45 #ifndef _TEUCHOS_OBJECT_HPP_
46 #define _TEUCHOS_OBJECT_HPP_
47 
52 #include "Teuchos_ConfigDefs.hpp"
53 #include "Teuchos_DataAccess.hpp"
54 
55 // 2007/11/26: rabartl: This class has to change from using 'char*' to
56 // std::string!
57 
66 namespace Teuchos {
67 
69 public:
71 
72 
83  Object (int tracebackModeIn = -1);
84 
86 
90  Object (const char* label, int tracebackModeIn = -1);
91 
94  Object (const std::string& label, int tracebackModeIn = -1);
95 
97  virtual ~Object () {}
98 
100 
102 
103  // LEGACY; REPLACE "const char*" with std::string.
104  virtual void setLabel (const char* theLabel);
105 
118  static void setTracebackMode (int tracebackModeValue);
119 
121 
123 
125  virtual const char* label () const;
126 
128  static int getTracebackMode();
129 
131 
133 
135  virtual void print (std::ostream& os) const;
136 
138 
140 
142  virtual int reportError (const std::string message, int errorCode) const;
143 
145 
146  static int tracebackMode;
147 
148 private:
150  std::string label_;
151 };
152 
155 std::ostream& operator<< (std::ostream& os, const Teuchos::Object& obj);
156 
157 } // namespace Teuchos
158 
159 #endif /* _TEUCHOS_OBJECT_HPP_ */
static int tracebackMode
virtual ~Object()
Destructor (virtual, for safety of derived classes).
Teuchos header file which uses auto-configuration information to include necessary C++ headers...
#define TEUCHOSNUMERICS_LIB_DLL_EXPORT
std::ostream & operator<<(std::ostream &os, BigUInt< n > a)
The base Teuchos class.
std::string label_
The Object&#39;s current label.
Teuchos::DataAccess Mode enumerable type.