Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_VerboseObjectParameterListHelpers.hpp
Go to the documentation of this file.
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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
00030 #define TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
00031 
00032 #include "Teuchos_VerboseObject.hpp"
00033 #include "Teuchos_ParameterList.hpp"
00034 
00035 
00036 namespace Teuchos {
00037 
00038 
00047 TEUCHOS_LIB_DLL_EXPORT RCP<const ParameterList> getValidVerboseObjectSublist();
00048 
00049 
00062 TEUCHOS_LIB_DLL_EXPORT void setupVerboseObjectSublist( ParameterList* paramList );
00063 
00087 TEUCHOS_LIB_DLL_EXPORT void readVerboseObjectSublist(
00088   ParameterList* paramList,
00089   RCP<FancyOStream> *oStream, EVerbosityLevel *verbLevel
00090   );
00091 
00092 
00109 template<class ObjectType>
00110 void readVerboseObjectSublist(
00111   ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
00112   );
00113 
00114 
00115 } // namespace Teuchos
00116 
00117 
00118 // /////////////////////////////////
00119 // Implementations
00120 
00121 
00122 template<class ObjectType>
00123 void Teuchos::readVerboseObjectSublist(
00124   ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
00125   )
00126 {
00127   TEST_FOR_EXCEPT(0==paramList);
00128   TEST_FOR_EXCEPT(0==verboseObject);
00129   const EVerbosityLevel bogusVerbLevel = static_cast<EVerbosityLevel>(-50);
00130   RCP<FancyOStream> oStream = null;
00131   EVerbosityLevel verbLevel = bogusVerbLevel;
00132   readVerboseObjectSublist(paramList,&oStream,&verbLevel);
00133   verboseObject->setOverridingOStream(oStream);
00134   verboseObject->setOverridingVerbLevel(verbLevel);
00135 }
00136 
00137 
00138 #endif // TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines