Teuchos_VerboseObjectParameterListHelpers.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

#ifndef TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
#define TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP

#include "Teuchos_VerboseObject.hpp"
#include "Teuchos_ParameterList.hpp"


namespace Teuchos {


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP<const ParameterList> getValidVerboseObjectSublist();


TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setupVerboseObjectSublist( ParameterList* paramList );

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void readVerboseObjectSublist(
  ParameterList* paramList,
  RCP<FancyOStream> *oStream, EVerbosityLevel *verbLevel
  );


template<class ObjectType>
void readVerboseObjectSublist(
  ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
  );


} // namespace Teuchos


// /////////////////////////////////
// Implementations


template<class ObjectType>
void Teuchos::readVerboseObjectSublist(
  ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
  )
{
  TEUCHOS_TEST_FOR_EXCEPT(0==paramList);
  TEUCHOS_TEST_FOR_EXCEPT(0==verboseObject);
  const EVerbosityLevel bogusVerbLevel = static_cast<EVerbosityLevel>(-50);
  RCP<FancyOStream> oStream = null;
  EVerbosityLevel verbLevel = bogusVerbLevel;
  readVerboseObjectSublist(paramList,&oStream,&verbLevel);
  verboseObject->setOverridingOStream(oStream);
  verboseObject->setOverridingVerbLevel(verbLevel);
}


#endif // TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP