Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_VerboseObjectParameterListHelpers.hpp
1// @HEADER
2// *****************************************************************************
3// Teuchos: Common Tools Package
4//
5// Copyright 2004 NTESS and the Teuchos contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
11#define TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
12
13#include "Teuchos_VerboseObject.hpp"
15
16
17namespace Teuchos {
18
19
28TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP<const ParameterList> getValidVerboseObjectSublist();
29
30
43TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setupVerboseObjectSublist( ParameterList* paramList );
44
68TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void readVerboseObjectSublist(
71 );
72
73
90template<class ObjectType>
93 );
94
95
96} // namespace Teuchos
97
98
99// /////////////////////////////////
100// Implementations
101
102
103template<class ObjectType>
104void Teuchos::readVerboseObjectSublist(
106 )
107{
110 const EVerbosityLevel bogusVerbLevel = static_cast<EVerbosityLevel>(-50);
113 readVerboseObjectSublist(paramList,&oStream,&verbLevel);
114 verboseObject->setOverridingOStream(oStream);
115 verboseObject->setOverridingVerbLevel(verbLevel);
116}
117
118
119#endif // TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
Templated Parameter List class.
A list of parameters of arbitrary type.
Smart reference counting pointer class for automatic garbage collection.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void readVerboseObjectSublist(ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
Read the parameters in the "VerboseObject" sublist and set them on the given VerboseObject.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setupVerboseObjectSublist(ParameterList *paramList)
Setup a sublist called "VerboseObject" in the given parameter list.
void readVerboseObjectSublist(ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
Read the parameters in the "VerboseObject" sublist and set them on the given VerboseObject.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > getValidVerboseObjectSublist()
Return the sublist of valid parameters for the "VerboseObject" sublist.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
This macro is designed to be a short version of TEUCHOS_TEST_FOR_EXCEPTION() that is easier to call.
EVerbosityLevel
Verbosity level.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...