Teuchos Package Browser (Single Doxygen Collection)
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
parameterlist
src
Teuchos_ValidatorXMLConverter.cpp
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
#include "
Teuchos_ValidatorXMLConverter.hpp
"
43
44
namespace
Teuchos
{
45
46
RCP<ParameterEntryValidator>
47
ValidatorXMLConverter::fromXMLtoValidator
(
48
const
XMLObject
& xmlObj,
49
const
IDtoValidatorMap
& validatorIDsMap)
const
50
{
51
#ifdef HAVE_TEUCHOS_DEBUG
52
RCP<const ParameterEntryValidator>
dummyValidator = getDummyValidator();
53
TEUCHOS_TEST_FOR_EXCEPTION
(
54
xmlObj.
getRequired
(
getTypeAttributeName
())
55
!=
56
dummyValidator->getXMLTypeName(),
57
BadValidatorXMLConverterException
,
58
"Cannot convert xmlObject "
<<
59
". Expected a "
<< dummyValidator->getXMLTypeName() <<
60
" tag but got a "
<< xmlObj.
getRequired
(
getTypeAttributeName
()) <<
"type"
);
61
#endif
62
RCP<ParameterEntryValidator>
toReturn =
63
convertXML
(xmlObj, validatorIDsMap);
64
return
toReturn;
65
}
66
67
XMLObject
68
ValidatorXMLConverter::fromValidatortoXML
(
69
const
RCP<const ParameterEntryValidator>
validator,
70
const
ValidatortoIDMap
& validatorIDsMap,
71
bool
assignedID)
const
72
{
73
#ifdef HAVE_TEUCHOS_DEBUG
74
RCP<const ParameterEntryValidator>
dummyValidator = getDummyValidator();
75
TEUCHOS_TEST_FOR_EXCEPTION
(
76
validator->getXMLTypeName()
77
!=
78
dummyValidator->getXMLTypeName(),
79
BadValidatorXMLConverterException
,
80
"Cannot convert Validator "
<<
81
". Expected a "
<< dummyValidator->getXMLTypeName() <<
82
" validator but got a "
<< validator->getXMLTypeName() <<
"type"
);
83
#endif
84
XMLObject
toReturn(
getValidatorTagName
());
85
toReturn.
addAttribute
(
getTypeAttributeName
(), validator->getXMLTypeName());
86
if
(assignedID){
87
TEUCHOS_TEST_FOR_EXCEPTION
(validatorIDsMap.
find
(validator) == validatorIDsMap.
end
(),
88
MissingValidatorDefinitionException
,
89
"Could not find an id associated with the validator in the "
90
"given validatorIDsMap to use when "
<<
91
"writing it to XML!"
<< std::endl << std::endl);
92
toReturn.
addAttribute
(
getIdAttributeName
(),
93
validatorIDsMap.
find
(validator)->second);
94
}
95
convertValidator
(validator, toReturn, validatorIDsMap);
96
return
toReturn;
97
}
98
99
100
}
101
Teuchos_ValidatorXMLConverter.hpp
Converts back and forth between XML and ParameterEntryValidators.
Teuchos::BadValidatorXMLConverterException
Thrown when a bad validator xml converter is used.
Definition
Teuchos_XMLParameterListExceptions.hpp:108
Teuchos::IDtoValidatorMap
Maps Validators to integers.
Definition
Teuchos_ValidatorMaps.hpp:57
Teuchos::MissingValidatorDefinitionException
Thrown when a referenced validator can't be found.
Definition
Teuchos_XMLParameterListExceptions.hpp:226
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition
Teuchos_RCPDecl.hpp:429
Teuchos::ValidatorXMLConverter::fromValidatortoXML
XMLObject fromValidatortoXML(const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const
Converters a given ParameterEntryValidator to XML.
Definition
Teuchos_ValidatorXMLConverter.cpp:68
Teuchos::ValidatorXMLConverter::getValidatorTagName
static const std::string & getValidatorTagName()
Definition
Teuchos_ValidatorXMLConverter.hpp:165
Teuchos::ValidatorXMLConverter::getIdAttributeName
static const std::string & getIdAttributeName()
Definition
Teuchos_ValidatorXMLConverter.hpp:147
Teuchos::ValidatorXMLConverter::convertValidator
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...
Teuchos::ValidatorXMLConverter::fromXMLtoValidator
RCP< ParameterEntryValidator > fromXMLtoValidator(const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
Converts a given XMLObject to a ParameterEntryValidator.
Definition
Teuchos_ValidatorXMLConverter.cpp:47
Teuchos::ValidatorXMLConverter::convertXML
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.
Teuchos::ValidatorXMLConverter::getTypeAttributeName
static const std::string & getTypeAttributeName()
Definition
Teuchos_ValidatorXMLConverter.hpp:159
Teuchos::ValidatortoIDMap
A class for mapping validators to integers.
Definition
Teuchos_ValidatorMaps.hpp:104
Teuchos::ValidatortoIDMap::end
const_iterator end() const
Returns a const_reference to the end of the map.
Definition
Teuchos_ValidatorMaps.cpp:97
Teuchos::ValidatortoIDMap::find
const_iterator find(const RCP< const ParameterEntryValidator > validator) const
Returns an iterator to the validator and id specified by the validator.
Definition
Teuchos_ValidatorMaps.cpp:84
Teuchos::XMLObject
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
Definition
Teuchos_XMLObject.hpp:62
Teuchos::XMLObject::getRequired
const std::string & getRequired(const std::string &name) const
Get an attribute, throwing an std::exception if it is not found.
Definition
Teuchos_XMLObject.cpp:93
Teuchos::XMLObject::addAttribute
void addAttribute(const std::string &name, T value)
Lookup whether or not Doubles are allowed.
Definition
Teuchos_XMLObject.hpp:193
TEUCHOS_TEST_FOR_EXCEPTION
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
Definition
Teuchos_TestForException.hpp:178
Teuchos
Definition
Teuchos_AbstractFactory.hpp:47
Generated by
1.17.0