Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_DependencyXMLConverter.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
12
13
14namespace Teuchos{
15
16
17RCP<Dependency>
19 const XMLObject& xmlObj,
22{
25
28 "Could not find any dependees for a dependency!"
29 <<std::endl <<std::endl);
30
33 "Could not find any dependents for a dependency!"
34 <<std::endl <<std::endl);
35
36 for(int i=0; i<xmlObj.numChildren(); ++i){
37 XMLObject child = xmlObj.getChild(i);
38 if(child.getTag() == getDependeeTagName()){
42
45 "Can't find a Dependee ParameterEntry associated with the ID: " <<
46 dependeeID << std::endl << std::endl);
47 dependees.insert(entryIDsMap.find(dependeeID)->second);
48 }
49 else if(child.getTag() == getDependentTagName()){
53
56 "Can't find a Dependent ParameterEntry associated with the ID: " <<
57 dependentID << std::endl << std::endl);
58 dependents.insert(entryIDsMap.find(dependentID)->second);
59 }
60 }
61
62 return convertXML(
64}
65
71{
73
74 toReturn.addAttribute(getTypeAttributeName(),
75 dependency->getTypeAttributeValue());
76
77 Dependency::ConstParameterEntryList::const_iterator it =
78 dependency->getDependees().begin();
79
80 for(;it != dependency->getDependees().end(); ++it){
84 "Can't find the Dependee of a dependency in the given " <<
85 "EntryIDsMap. Occurred when converting " <<
86 "to XML" << std::endl << std::endl);
88 getParameterIdAttributeName(), entryIDsMap.find(*it)->second);
89 toReturn.addChild(currentDependee);
90 }
91
92 it = dependency->getDependents().begin();
93 for(; it != dependency->getDependents().end(); ++it){
97 "Can't find the Dependent of a dependency in the given " <<
98 "ValidatordIDsMap. Occurred when converting " <<
99 "to XML" << std::endl << std::endl);
101 getParameterIdAttributeName(), entryIDsMap.find(*it)->second);
102 toReturn.addChild(currentDependent);
103 }
104
106
107 return toReturn;
108}
109
110
111} // namespace Teuchos
112
Converts back and forth between XML and Dependencies.
A collection of Exceptions thrown when converting Dependencys to and from XML.
static const std::string & getDependentTagName()
Returns the string to be used for the dependent tag.
virtual void convertDependency(const RCP< const Dependency > dependency, XMLObject &xmlObj, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const =0
Preforms any and all special dependency conversion that is specific to a particlar Dependency.
static const std::string & getTypeAttributeName()
Returns the string to be used for the type attribute.
static const std::string & getParameterIdAttributeName()
Returns the string to be used for the ParameterID attribute.
virtual RCP< Dependency > convertXML(const XMLObject &xmlObj, const Dependency::ConstParameterEntryList dependees, const Dependency::ParameterEntryList dependets, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const =0
Preforms any and all special xml conversion that is specific to a particular Dependency.
RCP< Dependency > fromXMLtoDependency(const XMLObject &xmlObj, const XMLParameterListReader::EntryIDsMap &entryIDsMap, const IDtoValidatorMap &validatorIDsMap) const
Converts a given XMLObject to a Dependency.
static const std::string & getDependeeTagName()
Returns the string to be used for the dependee tag.
XMLObject fromDependencytoXML(const RCP< const Dependency > dependency, const XMLParameterListWriter::EntryIDsMap &entryIDsMap, ValidatortoIDMap &validatorIDsMap) const
Converters a given ParameterEntryValidator to XML.
static const std::string & getXMLTagName()
Returns the XML tag to use when serializing Dependencies.
std::set< RCP< ParameterEntry >, RCPComp > ParameterEntryList
A list of Dependees.
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
Maps Validators to integers.
Thrown when no dependes of a dependency can't be found when converting the dependency to or from XML.
Thrown when no dependess of a dependency are specified when converting the dependency from XML.
Thrown when a dependent of a dependency cant be found when converting the dependency to or from XML.
Thrown when no dependents of a dependency are specified when converting the dependency from XML.
Smart reference counting pointer class for automatic garbage collection.
A class for mapping validators to integers.
Representation of an XML data tree. XMLObject is a ref-counted handle to a XMLObjectImplem object,...
std::map< ParameterEntry::ParameterEntryID, RCP< ParameterEntry > > EntryIDsMap
Convenience typedef.
std::map< RCP< const ParameterEntry >, ParameterEntry::ParameterEntryID, RCPConstComp > EntryIDsMap
#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,...