Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
43 
44 namespace Teuchos{
45 
46 RCP<ParameterEntryValidator>
48  const XMLObject& xmlObj,
49  const IDtoValidatorMap& validatorIDsMap) const
50 {
51  #ifdef HAVE_TEUCHOS_DEBUG
52  RCP<const ParameterEntryValidator> dummyValidator = getDummyValidator();
55  !=
56  dummyValidator->getXMLTypeName(),
58  "Cannot convert xmlObject " <<
59  ". Expected a " << dummyValidator->getXMLTypeName() <<
60  " tag but got a " << xmlObj.getRequired(getTypeAttributeName()) << "type");
61  #endif
63  convertXML(xmlObj, validatorIDsMap);
64  return toReturn;
65 }
66 
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();
76  validator->getXMLTypeName()
77  !=
78  dummyValidator->getXMLTypeName(),
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(),
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 
static const std::string & getIdAttributeName()
Maps Validators to integers.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
XMLObject fromValidatortoXML(const RCP< const ParameterEntryValidator > validator, const ValidatortoIDMap &validatorIDsMap, bool assignedID=true) const
Converters a given ParameterEntryValidator to XML.
static const std::string & getTypeAttributeName()
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object...
Converts back and forth between XML and ParameterEntryValidators.
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...
const_iterator end() const
Returns a const_reference to the end of the map.
static const std::string & getValidatorTagName()
A class for mapping validators to integers.
const_iterator find(const RCP< const ParameterEntryValidator > validator) const
Returns an iterator to the validator and id specified by the validator.
Smart reference counting pointer class for automatic garbage collection.
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...
const std::string & getRequired(const std::string &name) const
Get an attribute, throwing an std::exception if it is not found.
Thrown when a bad validator xml converter is used.
Thrown when a referenced validator can&#39;t be found.