Teuchos_FunctionObjectXMLConverterDB.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP
#define TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP

// All includes needed for convience macros below
#include "Teuchos_StandardFunctionObjectXMLConverters.hpp"
#include "Teuchos_StandardFunctionObjects.hpp"
#include "Teuchos_DummyObjectGetter.hpp"


namespace Teuchos {

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT FunctionObjectXMLConverterDB {

public:


  static void addConverter(
    RCP<const FunctionObject> function,
    RCP<FunctionObjectXMLConverter> converterToAdd);



  static RCP<const FunctionObjectXMLConverter>
    getConverter(const FunctionObject& function);

  static RCP<const FunctionObjectXMLConverter>
    getConverter(const XMLObject& xmlObject);

  static XMLObject convertFunctionObject(RCP<const FunctionObject> function);

  static RCP<FunctionObject> convertXML(const XMLObject& xmlObject);


  static void printKnownConverters(std::ostream& out){
    out << "Known ConditionXMLConverters: " << std::endl;
    for(
      ConverterMap::const_iterator it = getConverterMap().begin();
      it != getConverterMap().end();
      ++it)
    {
      out << "\t" << it->first <<std::endl;
    }
  }


private:


  typedef std::map<std::string, RCP<FunctionObjectXMLConverter> > ConverterMap;

  typedef std::pair<std::string, RCP<FunctionObjectXMLConverter> > ConverterPair;

  static ConverterMap& getConverterMap();


};


} // end namespace Teuchos

//
// Helper Macros
//

#define TEUCHOS_ADD_SIMPLEFUNCTIONCONVERTERS(T) \
  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
    Teuchos::rcp(new Teuchos::SubtractionFunction< T >), \
    Teuchos::DummyObjectGetter<Teuchos::SubtractionFunctionXMLConverter< T > >:: \
      getDummyObject()); \
      \
  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
    Teuchos::rcp(new Teuchos::AdditionFunction< T >), \
    Teuchos::DummyObjectGetter<Teuchos::AdditionFunctionXMLConverter< T > >:: \
      getDummyObject()); \
      \
  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
    Teuchos::rcp(new Teuchos::MultiplicationFunction< T >), \
    Teuchos::DummyObjectGetter<Teuchos::MultiplicationFunctionXMLConverter< T > >:: \
      getDummyObject()); \
      \
  Teuchos::FunctionObjectXMLConverterDB::addConverter( \
    Teuchos::rcp(new Teuchos::DivisionFunction< T >), \
    Teuchos::DummyObjectGetter<Teuchos::DivisionFunctionXMLConverter< T > >:: \
      getDummyObject()); \
      \

#endif // TEUCHOS_FUNTIONOBJECTXMLCONVERTERDB_HPP