Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_ConditionXMLConverter.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_CONDITIONXMLCONVERTER_HPP
00043 #define TEUCHOS_CONDITIONXMLCONVERTER_HPP
00044 
00050 #include "Teuchos_XMLObject.hpp"
00051 #include "Teuchos_Describable.hpp"
00052 #include "Teuchos_Condition.hpp"
00053 #include "Teuchos_XMLParameterListReader.hpp"
00054 #include "Teuchos_XMLParameterListWriter.hpp"
00055 
00056 
00057 namespace Teuchos {
00058 
00059 
00063 class TEUCHOS_LIB_DLL_EXPORT ConditionXMLConverter : public Describable {
00064 
00065 public:
00066 
00069   
00077   RCP<Condition>
00078   fromXMLtoCondition(
00079     const XMLObject& xmlObj,
00080     const XMLParameterListReader::EntryIDsMap& entryIDsMap) const;
00081 
00091   virtual RCP<Condition> convertXML(
00092     const XMLObject& xmlObj,
00093     const XMLParameterListReader::EntryIDsMap& entryIDsMap) const=0;
00094 
00102   XMLObject fromConditiontoXML(
00103     const RCP<const Condition> condition,
00104     const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const;
00105   
00116   virtual void convertCondition(
00117     const RCP<const Condition> condition, 
00118     XMLObject& xmlObj,
00119     const XMLParameterListWriter::EntryIDsMap& entryIDsMap) const = 0;
00120   
00122 
00124 
00125 
00127   static const std::string& getTypeAttributeName(){
00128     static const std::string typeAttributeName = "type";
00129     return typeAttributeName;
00130   }
00131  
00133 
00134 };
00135 
00136 
00137 } // namespace Teuchos
00138 
00139 
00140 #endif // TEUCHOS_CONDITIONXMLCONVERTER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines