ConditionalOStream.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2021.                                                        *
 * The Regents of the University of Michigan and DFT-EFE developers.          *
 *                                                                            *
 * This file is part of the DFT-EFE code.                                     *
 *                                                                            *
 * DFT-EFE is free software: you can redistribute it and/or modify            *
 *   it under the terms of the Lesser GNU General Public License as           *
 *   published by the Free Software Foundation, either version 3 of           *
 *   the License, or (at your option) any later version.                      *
 *                                                                            *
 * DFT-EFE is distributed in the hope that it will be useful, but             *
 *   WITHOUT ANY WARRANTY; without even the implied warranty                  *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
 *   See the Lesser GNU General Public License for more details.              *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public           *
 *   License at the top level of DFT-EFE distribution.  If not, see           *
 *   <https://www.gnu.org/licenses/>.                                         *
 ******************************************************************************/
 
/*
 * @author Bikash Kanungo
 */
#ifndef dftefeConditionalOstream_h
#define dftefeConditionalOstream_h
 
#include <ostream>
 
//
// ACKNOWLEDGEMENT: The implementation of this class is borrowed from deal.II
//
namespace dftefe
{
  namespace utils
  {
    class ConditionalOStream
    {
    public:
      ConditionalOStream(std::ostream &stream, const bool active = true);
 
      void
      setCondition(const bool active);
 
      bool
      isActive() const;
 
      std::ostream &
      getOStream() const;
 
      template <typename T>
      const ConditionalOStream &
      operator<<(const T &t) const;
 
      const ConditionalOStream &
      operator<<(std::ostream &(*p)(std::ostream &)) const;
 
    private:
      std::ostream &d_outputStream;
      bool          d_activeFlag;
    }; // end of class ConditionalOStream
 
  } // end of namespace utils
} // end of namespace dftefe
 
#include <utils/ConditionalOStream.t.cpp>
#endif // dftefeConditionalOstream_h