Teuchos - Trilinos Tools Package Version of the Day
Teuchos_VerboseObjectParameterListHelpers.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
00043 #define TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
00044 
00045 #include "Teuchos_VerboseObject.hpp"
00046 #include "Teuchos_ParameterList.hpp"
00047 
00048 
00049 namespace Teuchos {
00050 
00051 
00060 TEUCHOS_LIB_DLL_EXPORT RCP<const ParameterList> getValidVerboseObjectSublist();
00061 
00062 
00075 TEUCHOS_LIB_DLL_EXPORT void setupVerboseObjectSublist( ParameterList* paramList );
00076 
00100 TEUCHOS_LIB_DLL_EXPORT void readVerboseObjectSublist(
00101   ParameterList* paramList,
00102   RCP<FancyOStream> *oStream, EVerbosityLevel *verbLevel
00103   );
00104 
00105 
00122 template<class ObjectType>
00123 void readVerboseObjectSublist(
00124   ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
00125   );
00126 
00127 
00128 } // namespace Teuchos
00129 
00130 
00131 // /////////////////////////////////
00132 // Implementations
00133 
00134 
00135 template<class ObjectType>
00136 void Teuchos::readVerboseObjectSublist(
00137   ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
00138   )
00139 {
00140   TEUCHOS_TEST_FOR_EXCEPT(0==paramList);
00141   TEUCHOS_TEST_FOR_EXCEPT(0==verboseObject);
00142   const EVerbosityLevel bogusVerbLevel = static_cast<EVerbosityLevel>(-50);
00143   RCP<FancyOStream> oStream = null;
00144   EVerbosityLevel verbLevel = bogusVerbLevel;
00145   readVerboseObjectSublist(paramList,&oStream,&verbLevel);
00146   verboseObject->setOverridingOStream(oStream);
00147   verboseObject->setOverridingVerbLevel(verbLevel);
00148 }
00149 
00150 
00151 #endif // TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines