Teuchos - Trilinos Tools Package Version of the Day
Teuchos_DependencyXMLConverter.hpp
Go to the documentation of this file.
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 #ifndef TEUCHOS_DEPENDENCYXMLCONVERTER_HPP
00043 #define TEUCHOS_DEPENDENCYXMLCONVERTER_HPP
00044 
00050 #include "Teuchos_Dependency.hpp"
00051 #include "Teuchos_XMLObject.hpp"
00052 #include "Teuchos_XMLParameterListWriter.hpp"
00053 #include "Teuchos_XMLParameterListReader.hpp"
00054 #include "Teuchos_Describable.hpp"
00055 
00056 
00057 namespace Teuchos {
00058 
00059 
00063 class TEUCHOS_LIB_DLL_EXPORT DependencyXMLConverter : public Describable {
00064 
00065 public:
00066 
00069   
00079   RCP<Dependency> fromXMLtoDependency(
00080     const XMLObject& xmlObj,
00081     const XMLParameterListReader::EntryIDsMap& entryIDsMap,
00082     const IDtoValidatorMap& validatorIDsMap) const;
00083 
00097   virtual RCP<Dependency> convertXML(
00098     const XMLObject& xmlObj, 
00099     const Dependency::ConstParameterEntryList dependees,
00100     const Dependency::ParameterEntryList dependets,
00101     const XMLParameterListReader::EntryIDsMap& entryIDsMap,
00102     const IDtoValidatorMap& validatorIDsMap) const = 0;
00103 
00113   XMLObject fromDependencytoXML(
00114     const RCP<const Dependency> dependency,
00115     const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
00116     ValidatortoIDMap& validatorIDsMap) const;
00117   
00130   virtual void convertDependency(
00131     const RCP<const Dependency> dependency, 
00132     XMLObject& xmlObj,
00133     const XMLParameterListWriter::EntryIDsMap& entryIDsMap,
00134     ValidatortoIDMap& validatorIDsMap) const = 0;
00135   
00137 
00139 
00140 
00144   static const std::string& getDependeeTagName(){
00145     static const std::string dependeeTagName = "Dependee";
00146     return dependeeTagName;
00147   }
00148 
00152   static const std::string& getDependentTagName(){
00153     static const std::string dependentTagName = "Dependent";
00154     return dependentTagName;
00155   }
00156 
00160   static const std::string& getParameterIdAttributeName(){
00161     static const std::string parameterIdAtrributeName = "parameterId";
00162     return parameterIdAtrributeName;
00163   }
00164  
00168   static const std::string& getTypeAttributeName(){
00169     static const std::string typeAttributeName = "type";
00170     return typeAttributeName;
00171   }
00172  
00174 
00175 };
00176 
00177 
00178 } // namespace Teuchos
00179 
00180 
00181 #endif // TEUCHOS_DEPENDENCYXMLCONVERTER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines