Teuchos_Describable.hpp

// @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

#ifndef TEUCHOS_DESCRIBABLE_HPP
#define TEUCHOS_DESCRIBABLE_HPP

#include "Teuchos_ConfigDefs.hpp"

namespace Teuchos {

enum EVerbosityLevel {
  VERB_DEFAULT=0  
  ,VERB_LOW=1     
  ,VERB_MEDIUM=2  
  ,VERB_HIGH=3    
  ,VERB_EXTREME=4 
};

class Describable {
public:

  static const EVerbosityLevel   verbLevel_default;
  static const std::string       leadingIndent_default;
  static const std::string       indentSpacer_default;

  virtual ~Describable() {}


  virtual std::string description() const;

  virtual std::ostream& describe(
    std::ostream                &out
    ,const EVerbosityLevel      verbLevel     = verbLevel_default
    ,const std::string          leadingIndent = leadingIndent_default
    ,const std::string          indentSpacer  = indentSpacer_default
    ) const;

};

struct DescribableStreamManipulatorState {
  const Describable          &describable;
  const EVerbosityLevel      verbLevel;
  const std::string          leadingIndent;
  const std::string          indentSpacer;
  DescribableStreamManipulatorState(
    const Describable          &_describable
    ,const EVerbosityLevel     _verbLevel
    ,const std::string         _leadingIndent
    ,const std::string         _indentSpacer
    )
    :describable(_describable)
    ,verbLevel(_verbLevel)
    ,leadingIndent(_leadingIndent)
    ,indentSpacer(_indentSpacer)
    {}
};

inline DescribableStreamManipulatorState describe(
  const Describable          &describable
  ,const EVerbosityLevel     verbLevel     = Describable::verbLevel_default
  ,const std::string         leadingIndent = Describable::leadingIndent_default
  ,const std::string         indentSpacer  = Describable::indentSpacer_default
  )
{
  return DescribableStreamManipulatorState(describable,verbLevel,leadingIndent,indentSpacer);
}

inline
std::ostream& operator<<( std::ostream& os, const DescribableStreamManipulatorState& d )
{
  return d.describable.describe(os,d.verbLevel,d.leadingIndent,d.indentSpacer);
}

} // namespace Teuchos

#endif // TEUCHOS_DESCRIBABLE_HPP

---