/usr/include/trilinos/Teuchos_VerboseObjectParameterListHelpers.hpp is in libtrilinos-teuchos-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
#define TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
#include "Teuchos_VerboseObject.hpp"
#include "Teuchos_ParameterList.hpp"
namespace Teuchos {
/** \brief Return the sublist of valid parameters for the "VerboseObject"
* sublist.
*
* This function need not be directly called by clients since the function
* <tt>setupVerboseObjectSublist()</tt> sets up the sublist automatically.
*
* \relates VerboseObject
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP<const ParameterList> getValidVerboseObjectSublist();
/** \brief Setup a sublist called "VerboseObject" in the given parameter list.
*
* \param paramList
* [in/out] The parameter list hat the "VerboseObject" sublist will
* be added to
*
* <b>Preconditions:</b><ul>
* <li><tt>paramList!=0</tt>
* </ul>
*
* \relates VerboseObject
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setupVerboseObjectSublist( ParameterList* paramList );
/** \brief Read the parameters in the "VerboseObject" sublist and set them on
* the given VerboseObject.
*
* \param paramList
* [in/out] On input, contains the user's parameter list for the
* given objet for which "VerboseObject" can be a sublist of.
* \param oStream
* [out] The oStream object to be used. On output,
* <tt>oStream->get()!=0</tt> if an output stream was specified by
* the parameter sublist.
* \param verbLevel
* [out] The verbosity level to be used. On output,
* <tt>*verbLevel</tt> gives the verbosity level set in the parameter
* list. If no verbosity level was set, then a value of
* <tt>*verbLevel==VERB_DEFAULT</tt> will be set on return.
*
* <b>Preconditions:</b><ul>
* <li><tt>oStream!=0</tt>
* <li><tt>verbLevel!=0</tt>
* </ul>
*
* \relates VerboseObject
*/
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void readVerboseObjectSublist(
ParameterList* paramList,
RCP<FancyOStream> *oStream, EVerbosityLevel *verbLevel
);
/** \brief Read the parameters in the "VerboseObject" sublist and set them on
* the given VerboseObject.
*
* \param paramList
* [in/out] On input, contains the user's parameter list for the
* given object of which "VerboseObject" can be a sublist.
* \param verboseObject
* [in/out] The verbose object that will have its verbosity level
* and/or output stream set.
*
* This function just calls the above nontemplated
* <tt>readVerboseObjectSublist()</tt> to validate and and read the
* verbosity and output stream from the "VerboseObject" sublist.
*
* \relates VerboseObject
*/
template<class ObjectType>
void readVerboseObjectSublist(
ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
);
} // namespace Teuchos
// /////////////////////////////////
// Implementations
template<class ObjectType>
void Teuchos::readVerboseObjectSublist(
ParameterList* paramList, VerboseObject<ObjectType> *verboseObject
)
{
TEUCHOS_TEST_FOR_EXCEPT(0==paramList);
TEUCHOS_TEST_FOR_EXCEPT(0==verboseObject);
const EVerbosityLevel bogusVerbLevel = static_cast<EVerbosityLevel>(-50);
RCP<FancyOStream> oStream = null;
EVerbosityLevel verbLevel = bogusVerbLevel;
readVerboseObjectSublist(paramList,&oStream,&verbLevel);
verboseObject->setOverridingOStream(oStream);
verboseObject->setOverridingVerbLevel(verbLevel);
}
#endif // TEUCHOS_VERBOSE_OBJECT_PARAMETER_LIST_HELPERS_HPP
|