Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos_ValidatorXMLConverter.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_VALIDATORXMLCONVERTER_HPP
43#define TEUCHOS_VALIDATORXMLCONVERTER_HPP
44
50#include "Teuchos_XMLObject.hpp"
56
57
58namespace Teuchos {
59
60
65
66public:
67
70
79 fromXMLtoValidator(
80 const XMLObject& xmlObj,
82
94 const IDtoValidatorMap& validatorIDsMap) const=0;
95
106 XMLObject fromValidatortoXML(
109 bool assignedID=true) const;
110
120 virtual void convertValidator(
123 const ValidatortoIDMap& validatorIDsMap) const = 0;
124
126
127 #ifdef HAVE_TEUCHOS_DEBUG
130
138 getDummyValidator() const = 0;
139
141 #endif
142
144
145
147 static const std::string& getIdAttributeName(){
148 static const std::string idAttributeName = "validatorId";
149 return idAttributeName;
150 }
151
153 static const std::string& getPrototypeIdAttributeName(){
154 static const std::string prototypeIdAttributeName = "prototypeId";
156 }
157
159 static const std::string& getTypeAttributeName(){
160 static const std::string typeAttributeName = "type";
161 return typeAttributeName;
162 }
163
165 static const std::string& getValidatorTagName(){
166 static const std::string validatorTagName = "Validator";
167 return validatorTagName;
168 }
170
171};
172
173
174} // namespace Teuchos
175
176
177#endif // TEUCHOS_VALIDATORXMLCONVERTER_HPP
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
An object representation of a subset of XML data.
A collection of Exceptions that can be potentially thrown when converting a ParameterList to and from...
Writes an XML object to a parameter list.
Writes a ParameterList to an XML object.
Base class for all objects that can describe themselves.
Maps Validators to integers.
Concrete serial communicator subclass.
An abstract base class for converting ParameterEntryValidators to and from XML.
static const std::string & getValidatorTagName()
static const std::string & getIdAttributeName()
static const std::string & getPrototypeIdAttributeName()
virtual void convertValidator(const RCP< const ParameterEntryValidator > validator, XMLObject &xmlObj, const ValidatortoIDMap &validatorIDsMap) const =0
Preforms any and all special validator conversion that is specific to a particlar ParameterEntryValid...
virtual RCP< ParameterEntryValidator > convertXML(const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const =0
Preforms any and all special xml conversion that is specific to a particular ParameterEntryValidator.
static const std::string & getTypeAttributeName()
A class for mapping validators to integers.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...