Teuchos_XMLParameterListReader.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_XMLPARAMETERLISTREADER_H
#define Teuchos_XMLPARAMETERLISTREADER_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 XMLParameterListReader{

public:


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




  XMLParameterListReader();

  RCP<ParameterList> toParameterList(
    const XMLObject& xml, RCP<DependencySheet> depSheet) const;

  ParameterList toParameterList(const XMLObject& xml) const;

  void setAllowsDuplicateSublists(bool policy);

  bool getAllowsDuplicateSublists() const;

private:

  bool _allowDuplicateSublists;

  void convertParameterList(const XMLObject& xml,
    RCP<ParameterList> parentList,
    EntryIDsMap& entryIDsMap, const IDtoValidatorMap& validatorIDsMap) const;

  void convertValidators(
    const XMLObject& xml, IDtoValidatorMap& validatorIDsMap) const;

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

  void testForDuplicateValidatorIDs(
    ParameterEntryValidator::ValidatorID potentialNewID,
    const IDtoValidatorMap& currentMap) const;

  void insertEntryIntoMap(
    const XMLObject& xmlObj,
    RCP<ParameterEntry> entryToInsert,
    EntryIDsMap& entryIDsMap) const;

};



} // namespace Teuchos


#endif