/usr/include/trilinos/Teuchos_ParameterEntryValidator.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
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 | // @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.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
#define TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
#include "Teuchos_RCP.hpp"
#include "Teuchos_Array.hpp"
namespace Teuchos {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
class ParameterEntry;
#endif
/** \brief Abstract interface for an object that can validate a
* ParameterEntry's value.
*
* Not only can a validator validate and entry but it can also help to set
* and/or adjust the default value.
*/
class TEUCHOS_LIB_DLL_EXPORT ParameterEntryValidator {
public:
/** \brief . */
virtual ~ParameterEntryValidator() {}
/** \brief Print documentation for this parameter.
*
* \param docString
* [in] (Multi-line) documentation std::string.
* \param out
* [out] The std::ostream used for the output
*
* The purpose of this function is to augment what is in <tt>docString</tt>
* with some description of what valid values this parameter validator will
* accept.
*/
virtual void printDoc(
std::string const& docString
,std::ostream & out
) const = 0;
/** \brief Return an array of strings of valid values if applicable.
*
* If there is no such array of std::string values that makes since, just return
* <tt>return.get()==NULL</tt>.
*
* The returned strings must not contain any newlines (i.e. no <tt>'\n'</tt>
* characters) and must be short enough to fit on one line and be readable.
*/
virtual Teuchos::RCP<const Array<std::string> >
validStringValues() const = 0;
/** \brief Validate a parameter entry value and throw std::exception (with a
* great error message) if validation fails.
*
* \param entry
* [in] The ParameterEntry who's type and value is being validated
* \param paramName
* [in] The name of the ParameterEntry that is used to build error messages.
* \param sublistName
* [in] The name of the ParameterList that <tt>paramName</tt> exists in
* that is used to build error messages.
*/
virtual void validate(
ParameterEntry const& entry,
std::string const& paramName,
std::string const& sublistName
) const = 0;
/** \brief Validate and perhaps modify a parameter entry's value.
*
* \param paramName
* [in] The name of the ParameterEntry that is used to build error messages.
* \param sublistName
* [in] The name of the ParameterList that <tt>paramName</tt> exists in
* that is used to build error messages.
* \param entry
* [in/out] The ParameterEntry who's type and value is being validated and
* perhaps even changed as a result of calling this function.
*
* The default implementation simply calls <tt>this->validate()</tt>.
*/
virtual void validateAndModify(
std::string const& paramName,
std::string const& sublistName,
ParameterEntry * entry
) const
{
TEST_FOR_EXCEPT(0==entry);
this->validate(*entry,paramName,sublistName);
}
};
} // namespace Teuchos
#endif // TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
|