/usr/include/trilinos/Teuchos_DependencyXMLConverter.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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | // @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_DEPENDENCYXMLCONVERTER_HPP
#define TEUCHOS_DEPENDENCYXMLCONVERTER_HPP
/*! \file Teuchos_DependencyXMLConverter.hpp
* \brief Converts back and forth between XML
* and Dependencies.
*/
#include "Teuchos_Dependency.hpp"
#include "Teuchos_XMLObject.hpp"
#include "Teuchos_XMLParameterListWriter.hpp"
#include "Teuchos_XMLParameterListReader.hpp"
#include "Teuchos_Describable.hpp"
namespace Teuchos {
/** \brief An abstract base class for converting Dependencies to
* and from XML.
*/
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DependencyXMLConverter : public Describable {
public:
/** \name Converter Functions */
//@{
/** \brief Converts a given XMLObject to a Dependency.
*
* @param xmlObj The XMLObject to convert to a Dependency.
* @param entryIDsMap A map containing ParameterEntrys and their
* associated IDs.
* @param validtorIDsMap A map containing ParameterEntryValidators and their
* associated IDs.
* @return The converted Dependency.
*/
RCP<Dependency> fromXMLtoDependency(
const XMLObject& xmlObj,
const XMLParameterListReader::EntryIDsMap& entryIDsMap,
const IDtoValidatorMap& validatorIDsMap) const;
/** \brief Preforms any and all special xml conversion that is specific to a
* particular Dependency.
*
* @param xmlObj The xml to be converted.
* in which this resulting dependency will be inserted.
* @param dependees The dependees of the dependency.
* @param dependents The dependents of the dependency.
* @param entryIDsMap A map containing ParameterEntrys and their
* associated IDs.
* @param validtorIDsMap A map containing ParameterEntryValidators and their
* associated IDs.
* @return The converted Dependency.
*/
virtual RCP<Dependency> convertXML(
const XMLObject& xmlObj,
const Dependency::ConstParameterEntryList dependees,
const Dependency::ParameterEntryList dependets,
const XMLParameterListReader::EntryIDsMap& entryIDsMap,
const IDtoValidatorMap& validatorIDsMap) const = 0;
/** \brief Converters a given ParameterEntryValidator to XML.
*
* @param dependency The Dependency to be converted to XML.
* @param entryIDsMap A map containing ParameterEntrys and their
* associated IDs.
* @param validtorIDsMap A map containing ParameterEntryValidators and their
* associated IDs.
* @return An XML representation of the given Dependency.
*/
XMLObject fromDependencytoXML(
const RCP<const Dependency> dependency,
const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
ValidatortoIDMap& validatorIDsMap) const;
/** \brief Preforms any and all special dependency conversion that is
* specific to a particlar Dependency.
*
* @param dependency The validator to be converted.
* @param xmlObj The XMLObject on which all child tags should be appended
* and attributes added.
* @param entryIDsMap A map containing ParameterEntrys and their
* associated IDs.
* @param validtorIDsMap A map containing ParameterEntryValidators and their
* associated IDs.
* @return An XML representation of the given Dependency.
*/
virtual void convertDependency(
const RCP<const Dependency> dependency,
XMLObject& xmlObj,
const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
ValidatortoIDMap& validatorIDsMap) const = 0;
//@}
//! \name Attribute/Query Functions
//@{
/**
* \brief Returns the string to be used for the dependee tag.
*/
static const std::string& getDependeeTagName(){
static const std::string dependeeTagName = "Dependee";
return dependeeTagName;
}
/**
* \brief Returns the string to be used for the dependent tag.
*/
static const std::string& getDependentTagName(){
static const std::string dependentTagName = "Dependent";
return dependentTagName;
}
/**
* \brief Returns the string to be used for the ParameterID attribute.
*/
static const std::string& getParameterIdAttributeName(){
static const std::string parameterIdAtrributeName = "parameterId";
return parameterIdAtrributeName;
}
/**
* \brief Returns the string to be used for the type attribute.
*/
static const std::string& getTypeAttributeName(){
static const std::string typeAttributeName = "type";
return typeAttributeName;
}
//@}
};
} // namespace Teuchos
#endif // TEUCHOS_DEPENDENCYXMLCONVERTER_HPP
|