Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_ParameterEntryXMLConverter.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_PARAMETERENTRYXMLCONVERTER_HPP
00043 #define TEUCHOS_PARAMETERENTRYXMLCONVERTER_HPP
00044 
00045 
00051 #include "Teuchos_ParameterEntry.hpp"
00052 #include "Teuchos_XMLObject.hpp"
00053 #include "Teuchos_Describable.hpp"
00054 #include "Teuchos_XMLParameterListWriter.hpp"
00055 
00056 
00057 namespace Teuchos {
00058 
00061 class TEUCHOS_LIB_DLL_EXPORT ParameterEntryXMLConverter : public Describable {
00062 
00063 public:
00064 
00067 
00073   ParameterEntry fromXMLtoParameterEntry(const XMLObject &xmlObj) const;
00074 
00081   XMLObject fromParameterEntrytoXML(
00082     RCP<const ParameterEntry> entry,
00083     const std::string &name,
00084     const ParameterEntry::ParameterEntryID& id,
00085     const ValidatortoIDMap& validatorIDsMap) const;
00086   
00087   virtual any getAny(const XMLObject& xmlObj) const=0;
00088 
00090 
00092 
00093   
00100   virtual const std::string getTypeAttributeValue() const=0;
00101 
00110   virtual const std::string getValueAttributeValue(
00111     RCP<const ParameterEntry > entry) const=0;
00112   
00114   static const std::string& getTypeAttributeName() {
00115     static const std::string typeAttributeName_ = "type";
00116     return typeAttributeName_;
00117   }
00118 
00120   static const std::string& getIdAttributeName() {
00121     static const std::string idAttributeName_ = "id";
00122     return idAttributeName_;
00123   }
00124 
00126   static const std::string& getValueAttributeName() {
00127     static const std::string valueAttributeName_ = "value";
00128     return valueAttributeName_;
00129   }
00130   
00132 
00133 private:
00134 
00137   
00139   static const std::string& getDefaultAttributeName() {
00140     static const std::string defaultAttributeName_ = "isDefault";
00141     return defaultAttributeName_;
00142   }
00143 
00145   static const std::string& getUsedAttributeName() {
00146     static const std::string usedAttributeName_ = "isUsed";
00147     return usedAttributeName_;
00148   }
00149   
00151   static const std::string& getDocStringAttributeName() {
00152     static const std::string docStringAttributeName_ = "docString";
00153     return docStringAttributeName_;
00154   }
00155   
00157 
00158 };
00159 
00160 
00161 } // namespace Teuchos
00162 
00163 
00164 #endif // TEUCHOS_PARAMETERENTRYXMLCONVERTER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines