Teuchos_Object.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

// Kris
// 07.08.03 -- Move into Teuchos package/namespace

#ifndef _TEUCHOS_OBJECT_HPP_
#define _TEUCHOS_OBJECT_HPP_

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_DataAccess.hpp"

// 2007/11/26: rabartl: This class has to change from using 'char*' to
// std::string!

namespace Teuchos {

class TEUCHOSNUMERICS_LIB_DLL_EXPORT Object {
public:


  Object (int tracebackModeIn = -1);


  Object (const char* label, int tracebackModeIn = -1);

  Object (const std::string& label, int tracebackModeIn = -1);

  virtual ~Object () {}



  // LEGACY; REPLACE "const char*" with std::string.
  virtual void setLabel (const char* theLabel);

  static void setTracebackMode (int tracebackModeValue);



  virtual const char* label () const;

  static int getTracebackMode();



  virtual void print (std::ostream& os) const;



  virtual int reportError (const std::string message, int errorCode) const;


  static int tracebackMode;

private:
  std::string label_;
};

std::ostream& operator<< (std::ostream& os, const Teuchos::Object& obj);

} // namespace Teuchos

#endif /* _TEUCHOS_OBJECT_HPP_ */