Teuchos - Trilinos Tools Package Version of the Day
Teuchos_ParameterEntryXMLConverter.cpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #include "Teuchos_ParameterEntryXMLConverter.hpp"
00043 #include "Teuchos_XMLParameterListExceptions.hpp"
00044 #include "Teuchos_ValidatorXMLConverter.hpp"
00045 #include "Teuchos_XMLParameterListWriter.hpp"
00046 #include "Teuchos_ParameterEntryXMLConverterDB.hpp"
00047 
00048 namespace Teuchos{
00049 
00050 
00051 ParameterEntry
00052 ParameterEntryXMLConverter::fromXMLtoParameterEntry(
00053   const XMLObject &xmlObj) const
00054 {
00055   #ifdef HAVE_TEUCHOS_DEBUG
00056     TEUCHOS_TEST_FOR_EXCEPTION(
00057       xmlObj.getRequired(getTypeAttributeName()) != getTypeAttributeValue(),
00058       BadParameterEntryXMLConverterTypeException,
00059       "Error: this Parameter Entry XML tag has a type different than "
00060       "the XMLConverter being used to convert it." <<std::endl <<
00061       "Parameter name: " << xmlObj.getRequired(
00062       XMLParameterListWriter::getNameAttributeName()) << std::endl << 
00063       "XML Parameter Entry type: " << 
00064       xmlObj.getRequired(getTypeAttributeName()) << std::endl << 
00065       "XMLConverter type: " << getTypeAttributeValue() << 
00066       std::endl <<std::endl);
00067   #endif
00068 
00069   TEUCHOS_TEST_FOR_EXCEPTION(
00070     !xmlObj.hasAttribute(getValueAttributeName()), 
00071     NoValueAttributeExecption,
00072     ParameterEntry::getTagName() <<" tags must "
00073     "have a " << getValueAttributeName() << " attribute" << std::endl <<
00074     "Bad Parameter: " << 
00075     xmlObj.getAttribute(XMLParameterListWriter::getNameAttributeName()) <<
00076     std::endl << std::endl);
00077 
00078   ParameterEntry toReturn;
00079   bool isDefault = false;
00080   bool isUsed = false;
00081   std::string docString = "";
00082 
00083 
00084   if(xmlObj.hasAttribute(getDefaultAttributeName())){
00085     isDefault = xmlObj.getRequiredBool(getDefaultAttributeName());
00086   }
00087 
00088   if(xmlObj.hasAttribute(getUsedAttributeName())){
00089     isUsed = xmlObj.getRequiredBool(getUsedAttributeName());
00090   }
00091 
00092   if(xmlObj.hasAttribute(getDocStringAttributeName())){
00093     docString = xmlObj.getRequired(getDocStringAttributeName());
00094   }
00095 
00096   toReturn.setAnyValue(getAny(xmlObj), isDefault);
00097   toReturn.setDocString(docString);
00098   
00099   if(isUsed){
00100     toReturn.getAny();
00101   }
00102   
00103   return toReturn;
00104 }
00105 
00106 
00107 XMLObject
00108 ParameterEntryXMLConverter::fromParameterEntrytoXML(
00109   RCP<const ParameterEntry> entry, 
00110   const std::string &name,
00111   const ParameterEntry::ParameterEntryID& id,
00112   const ValidatortoIDMap& validatorIDsMap) const
00113 {
00114   #ifdef HAVE_TEUCHOS_DEBUG
00115   TEUCHOS_TEST_FOR_EXCEPTION(
00116     (entry->getAny().typeName() != getTypeAttributeValue()) 
00117     &&
00118     (
00119       getTypeAttributeValue() != 
00120       ParameterEntryXMLConverterDB::getDefaultConverter()->getTypeAttributeValue()
00121     ),
00122     BadParameterEntryXMLConverterTypeException,
00123     "Error: This converter can't convert the given ParameterEntry to XML "
00124     "because their types don't match." << std::endl <<
00125     "Parameter name: " << name << std::endl <<
00126     "Parameter type: " << entry->getAny().typeName() << std::endl <<
00127     "Converter type: " << getTypeAttributeValue() << std::endl << std::endl);
00128   #endif
00129 
00130   XMLObject toReturn(ParameterEntry::getTagName());
00131   toReturn.addAttribute(
00132     XMLParameterListWriter::getNameAttributeName(), name);
00133   toReturn.addAttribute(getTypeAttributeName(), getTypeAttributeValue());
00134   toReturn.addAttribute(getDocStringAttributeName(), entry->docString());
00135   toReturn.addAttribute(getIdAttributeName(), id);
00136   toReturn.addAttribute(
00137     getValueAttributeName(), getValueAttributeValue(entry));
00138   toReturn.addBool(getDefaultAttributeName(), entry->isDefault());
00139   toReturn.addBool(getUsedAttributeName(), entry->isUsed());
00140   if(nonnull(entry->validator())){
00141     TEUCHOS_TEST_FOR_EXCEPTION(
00142       validatorIDsMap.find(entry->validator()) == validatorIDsMap.end(),
00143       MissingValidatorDefinitionException,
00144       "Could not find validator in given ValidatorIDsMap! " << 
00145       std::endl << std::endl);
00146     toReturn.addAttribute(
00147       ValidatorXMLConverter::getIdAttributeName(), 
00148       validatorIDsMap.find(entry->validator())->second);
00149   }
00150   return toReturn;
00151 }
00152 
00153 
00154 } // namespace Teuchos
00155 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines