Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_ValidatorXMLConverter.cpp
1// @HEADER
2// *****************************************************************************
3// Teuchos: Common Tools Package
4//
5// Copyright 2004 NTESS and the Teuchos contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
11
12namespace Teuchos{
13
14RCP<ParameterEntryValidator>
16 const XMLObject& xmlObj,
18{
19 #ifdef HAVE_TEUCHOS_DEBUG
22 xmlObj.getRequired(getTypeAttributeName())
23 !=
24 dummyValidator->getXMLTypeName(),
26 "Cannot convert xmlObject " <<
27 ". Expected a " << dummyValidator->getXMLTypeName() <<
28 " tag but got a " << xmlObj.getRequired(getTypeAttributeName()) << "type");
29 #endif
32 return toReturn;
33}
34
39 bool assignedID) const
40{
41 #ifdef HAVE_TEUCHOS_DEBUG
44 validator->getXMLTypeName()
45 !=
46 dummyValidator->getXMLTypeName(),
48 "Cannot convert Validator " <<
49 ". Expected a " << dummyValidator->getXMLTypeName() <<
50 " validator but got a " << validator->getXMLTypeName() << "type");
51 #endif
53 toReturn.addAttribute(getTypeAttributeName(), validator->getXMLTypeName());
54 if(assignedID){
57 "Could not find an id associated with the validator in the "
58 "given validatorIDsMap to use when " <<
59 "writing it to XML!" << std::endl << std::endl);
60 toReturn.addAttribute(getIdAttributeName(),
61 validatorIDsMap.find(validator)->second);
62 }
64 return toReturn;
65}
66
67
68}
69
Converts back and forth between XML and ParameterEntryValidators.
Thrown when a bad validator xml converter is used.
Maps Validators to integers.
Thrown when a referenced validator can't be found.
Smart reference counting pointer class for automatic garbage collection.
XMLObject fromValidatortoXML(const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const
Converters a given ParameterEntryValidator to XML.
static const std::string & getValidatorTagName()
static const std::string & getIdAttributeName()
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...
RCP< ParameterEntryValidator > fromXMLtoValidator(const XMLObject &xmlObj, const IDtoValidatorMap &validatorIDsMap) const
Converts a given XMLObject to a ParameterEntryValidator.
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,...
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...