/usr/include/trilinos/Teuchos_ParameterEntryXMLConverter.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 152 153 154 155 156 157 158 159 160 161 162 163 164 | // @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_PARAMETERENTRYXMLCONVERTER_HPP
#define TEUCHOS_PARAMETERENTRYXMLCONVERTER_HPP
/*! \file Teuchos_ParameterEntryXMLCoverter.hpp
* \brief The base class for all ParameterEntryXMLConverters.
*/
#include "Teuchos_ParameterEntry.hpp"
#include "Teuchos_XMLObject.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_XMLParameterListWriter.hpp"
namespace Teuchos {
/** \brief A class used to convert parameter entries to xml and vice versa.
*/
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterEntryXMLConverter : public Describable {
public:
/** \name Converter Functions */
//@{
/** \brief Converts the given xml into a parameter entry.
*
* \param xmlObj The xml to be converted to a parameter entry.
* \returns A ParameterEntry with the aspects specified by the xml.
*/
ParameterEntry fromXMLtoParameterEntry(const XMLObject &xmlObj) const;
/** \brief Converts the given parameter entry to xml.
*
* \param entry The parameter entry to convert to xml.
* \param name The name associated with the parameter entry.
* \returns An XMLObject representing the parameter entry.
*/
XMLObject fromParameterEntrytoXML(
RCP<const ParameterEntry> entry,
const std::string &name,
const ParameterEntry::ParameterEntryID& id,
const ValidatortoIDMap& validatorIDsMap) const;
virtual any getAny(const XMLObject& xmlObj) const=0;
//@}
//! \name Attribute/Query Methods
//@{
/** \brief Gets a string representing the value that should be assigned to
* the "type" attribute when converting a parameter entry to xml.
*
* \returns The value to be assigned to the "type" attribute when converting
* a parameter entry to xml.
*/
virtual const std::string getTypeAttributeValue() const=0;
/** \brief Gets the value to be assigned to the "value" attribute when
* converting the paramter entry to xml.
*
* \param entry The entry being converted.
*
* \returns The value to be assigned to the "value" attribute when
* converting the parameter entry to xml.
*/
virtual const std::string getValueAttributeValue(
RCP<const ParameterEntry > entry) const=0;
/** \brief . */
static const std::string& getTypeAttributeName() {
static const std::string typeAttributeName_ = "type";
return typeAttributeName_;
}
/** \brief . */
static const std::string& getIdAttributeName() {
static const std::string idAttributeName_ = "id";
return idAttributeName_;
}
/** \brief . */
static const std::string& getValueAttributeName() {
static const std::string valueAttributeName_ = "value";
return valueAttributeName_;
}
//@}
private:
/** \name Private Members */
//@{
/** \brief . */
static const std::string& getDefaultAttributeName() {
static const std::string defaultAttributeName_ = "isDefault";
return defaultAttributeName_;
}
/** \brief . */
static const std::string& getUsedAttributeName() {
static const std::string usedAttributeName_ = "isUsed";
return usedAttributeName_;
}
/** \brief . */
static const std::string& getDocStringAttributeName() {
static const std::string docStringAttributeName_ = "docString";
return docStringAttributeName_;
}
//@}
};
} // namespace Teuchos
#endif // TEUCHOS_PARAMETERENTRYXMLCONVERTER_HPP
|