Teuchos_XMLParameterListWriter.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_XMLPARAMETERLISTWRITER_H
#define Teuchos_XMLPARAMETERLISTWRITER_H


#include "Teuchos_ParameterList.hpp"
#include "Teuchos_XMLObject.hpp"
#include "Teuchos_Utils.hpp"
#include "Teuchos_DependencySheet.hpp"
#include "Teuchos_ValidatorMaps.hpp"


namespace Teuchos {


class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT XMLParameterListWriter {

public:


  typedef std::map<RCP<const ParameterEntry>,
    ParameterEntry::ParameterEntryID, RCPConstComp> EntryIDsMap;




  XMLParameterListWriter();

  XMLObject toXML(
    const ParameterList& p,
    RCP<const DependencySheet> depSheet = null) const;

  static const std::string& getParameterListTagName(){
    static const std::string parameterListTagName = "ParameterList";
    return parameterListTagName;
  }

  static const std::string& getNameAttributeName(){
    static const std::string nameAttributeName = "name";
    return nameAttributeName;
  }

  static const std::string& getValidatorsTagName(){
    static const std::string validatorsTagName = "Validators";
    return validatorsTagName;
  }

  static const std::string& getDependenciesTagName(){
    static const std::string dependenciesTagName = "Dependencies";
    return dependenciesTagName;
  }

private:

  XMLObject convertParameterList(
      const ParameterList& p,
      ParameterEntry::ParameterEntryID& idCounter,
      EntryIDsMap& entryIDsMap,
      const ValidatortoIDMap& validatorIDsMap) const;

  XMLObject convertValidators(
    const ParameterList& p,
    ValidatortoIDMap& validatorIDsMap) const;

  XMLObject convertDependencies(
    RCP<const DependencySheet> depSheet,
    const EntryIDsMap& entryIDsMap,
    ValidatortoIDMap& validatorIDsMap) const;

  void buildInitialValidatorMap(
    const ParameterList& p,
    ValidatortoIDMap& validatorIDsMap) const;
};


} // namespace teuchos


#endif