Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_VerboseObjectParameterListHelpers.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
43 #define TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
44 
45 #include "Teuchos_VerboseObject.hpp"
47 
48 
49 namespace Teuchos {
50 
51 
60 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP<const ParameterList> getValidVerboseObjectSublist();
61 
62 
75 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setupVerboseObjectSublist( ParameterList* paramList );
76 
100 TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void readVerboseObjectSublist(
101  ParameterList* paramList,
102  RCP<FancyOStream> *oStream, EVerbosityLevel *verbLevel
103  );
104 
105 
122 template<class ObjectType>
123 void readVerboseObjectSublist(
124  ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
125  );
126 
127 
128 } // namespace Teuchos
129 
130 
131 // /////////////////////////////////
132 // Implementations
133 
134 
135 template<class ObjectType>
136 void Teuchos::readVerboseObjectSublist(
137  ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
138  )
139 {
140  TEUCHOS_TEST_FOR_EXCEPT(0==paramList);
141  TEUCHOS_TEST_FOR_EXCEPT(0==verboseObject);
142  const EVerbosityLevel bogusVerbLevel = static_cast<EVerbosityLevel>(-50);
143  RCP<FancyOStream> oStream = null;
144  EVerbosityLevel verbLevel = bogusVerbLevel;
145  readVerboseObjectSublist(paramList,&oStream,&verbLevel);
146  verboseObject->setOverridingOStream(oStream);
147  verboseObject->setOverridingVerbLevel(verbLevel);
148 }
149 
150 
151 #endif // TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
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.
EVerbosityLevel
Verbosity level.
Templated Parameter List class.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.
#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...