Teuchos_Object.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @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 TEUCHOS_LIB_DLL_EXPORT Object
{
  public:



  Object(int tracebackModeIn = -1);


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


  Object(const Object& obj);


  virtual ~Object();

  



  virtual void setLabel(const char* label);


  static void setTracebackMode(int tracebackModeValue);





  virtual char* label() const;  

  static int getTracebackMode();




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



  virtual int reportError(const std::string message, int errorCode) const 
  {
  // NOTE:  We are extracting a C-style std::string from Message because 
  //        the SGI compiler does not have a real std::string class with 
  //        the << operator.  Some day we should get rid of ".c_str()"
  if ( (tracebackMode==1) && (errorCode < 0) )
  {  // Report fatal error
     std::cerr << std::endl << "Error in Teuchos Object with label: " << label_ << std::endl 
     << "Teuchos Error:  " << message.c_str() << "  Error Code:  " << errorCode << std::endl;
     return(errorCode);
        }
  if ( (tracebackMode==2) && (errorCode != 0 ) ) 
  {
     std::cerr << std::endl << "Error in Teuchos Object with label: " << label_ << std::endl 
     << "Teuchos Error:  " << message.c_str() << "  Error Code:  " << errorCode << std::endl;
     return(errorCode);
  }
  return(errorCode);
  }


  static int tracebackMode;  

 protected:

 private:

  char* label_;

}; // class Object

inline std::ostream& operator<<(std::ostream& os, const Teuchos::Object& Obj)
{
  os << Obj.label() << std::endl;
  Obj.print(os);
 
  return os;
}

} // namespace Teuchos

// #include "Teuchos_Object.cpp"


#endif /* _TEUCHOS_OBJECT_HPP_ */