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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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 TEUCHOSNUMERICS_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_ */