Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_VerboseObjectParameterListHelpers.cpp
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 // 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 #include "Teuchos_VerboseObjectParameterListHelpers.hpp"
00043 #include "Teuchos_StandardParameterEntryValidators.hpp"
00044 
00045 
00046 namespace {
00047 
00048 
00049 const std::string VerboseObject_name = "VerboseObject";
00050 
00051 const std::string OutputFile_name = "Output File";
00052 const std::string OutputFile_default = "none";
00053 
00054 const std::string VerbosityLevel_name = "Verbosity Level";
00055 const std::string  VerbosityLevel_default = "default";
00056 Teuchos::RCP<
00057   Teuchos::StringToIntegralParameterEntryValidator<Teuchos::EVerbosityLevel>
00058   >
00059 VerbosityLevel_validator;
00060 
00061 
00062 } // namespace
00063 
00064 
00065 
00066 Teuchos::RCP<const Teuchos::ParameterList>
00067 Teuchos::getValidVerboseObjectSublist()
00068 {
00069   using Teuchos::rcp_implicit_cast;
00070   static RCP<const ParameterList> validParams;
00071   if (is_null(validParams)) {
00072     RCP<ParameterList>
00073       pl = rcp(new ParameterList(VerboseObject_name));
00074     VerbosityLevel_validator = verbosityLevelParameterEntryValidator(VerbosityLevel_name);
00075     pl->set(
00076       VerbosityLevel_name, VerbosityLevel_default,
00077       "The verbosity level to use to override whatever is set in code.\n"
00078       "The value of \"default\" will allow the level set in code to be used.",
00079       rcp_implicit_cast<const ParameterEntryValidator>(VerbosityLevel_validator)
00080       );
00081     pl->set(
00082       OutputFile_name, OutputFile_default,
00083       "The file to send output to.  If the value \"none\" is used, then\n"
00084       "whatever is set in code will be used.  However, any other std::string value\n"
00085       "will be used to create an std::ofstream object to a file with the given name.\n"
00086       "Therefore, any valid file name is a valid std::string value for this parameter."
00087       );
00088     validParams = pl;
00089   }
00090   return validParams;
00091 }
00092 
00093 
00094 void Teuchos::setupVerboseObjectSublist( ParameterList* paramList )
00095 {
00096   TEUCHOS_TEST_FOR_EXCEPT(0==paramList);
00097   paramList->sublist(VerboseObject_name).setParameters(
00098     *getValidVerboseObjectSublist()
00099     ).disableRecursiveValidation();
00100 }
00101 
00102 
00103 void Teuchos::readVerboseObjectSublist(
00104   ParameterList* paramList,
00105   RCP<FancyOStream> *oStream, EVerbosityLevel *verbLevel
00106   )
00107 {
00108   // Validate input
00109   TEUCHOS_TEST_FOR_EXCEPT(0==paramList);
00110   TEUCHOS_TEST_FOR_EXCEPT(0==oStream);
00111   TEUCHOS_TEST_FOR_EXCEPT(0==verbLevel);
00112   ParameterList
00113     &voSublist = paramList->sublist(VerboseObject_name);
00114   voSublist.validateParameters(*getValidVerboseObjectSublist());
00115   const std::string
00116     outputFileStr = voSublist.get(OutputFile_name,OutputFile_default);
00117   *verbLevel = VerbosityLevel_validator->getIntegralValue(
00118     voSublist,VerbosityLevel_name,VerbosityLevel_default
00119     );
00120   if (outputFileStr==OutputFile_default) {
00121     *oStream = null;
00122   }
00123   else {
00124     RCP<std::ofstream>
00125       oFileStream = rcp(new std::ofstream(outputFileStr.c_str()));
00126     TEUCHOS_TEST_FOR_EXCEPTION_PURE_MSG(
00127       oFileStream->eof(), Exceptions::InvalidParameterValue,
00128       "Error, the file \"" << outputFileStr << "\n given by the parameter\n"
00129       "\'" << OutputFile_name << "\' in the sublist\n"
00130       "\'" << voSublist.name() << "\' count not be opened for output!"
00131       );
00132     *oStream = fancyOStream(rcp_implicit_cast<std::ostream>(oFileStream));
00133   }
00134 #ifdef TEUCHOS_DEBUG
00135   voSublist.validateParameters(*getValidVerboseObjectSublist());
00136 #endif
00137 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines