Teuchos_ParameterListModifier.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_ParameterListModifier_hpp_
#define TEUCHOS_ParameterListModifier_hpp_

#include "Teuchos_Describable.hpp"
#include "Teuchos_ParameterEntryValidator.hpp"
#include "Teuchos_map.hpp"
#include "Teuchos_RCP.hpp"
namespace Teuchos {


#ifndef DOXYGEN_SHOULD_SKIP_THIS
class ParameterList;
#endif

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterListModifier : public Describable {

public:



  ParameterListModifier() = default;

  ParameterListModifier(const std::string &name);

  virtual ~ParameterListModifier();


  ParameterListModifier& setName( const std::string &name );


  void printDoc(
    std::string const& docString,
    std::ostream &out
    ) const;


  Array<std::string> findMatchingBaseNames(const ParameterList &paramList,
      const std::string &baseName, const bool &findParameters = true,
      const bool &findSublists = true) const;

  virtual void modify(ParameterList &paramList, ParameterList &validParamList) const {};


  virtual void reconcile(ParameterList &paramList) const {};


  int expandParameters(const std::string &paramTemplateName, ParameterList &paramList,
      ParameterList &validParamList,
      const Array<std::string> &excludeParameters=Array<std::string>()) const;


  int expandSublists(const std::string &sublistTemplateName, ParameterList &paramList,
      ParameterList &validParamList,
      const Array<std::string> &excludeSublists=Array<std::string>()) const;


  int setDefaultsInSublists(const std::string &paramName, ParameterList &paramList,
      const Array<std::string> &sublistNames, const bool removeParam = true) const;


  int expandSublistsUsingBaseName(const std::string &baseName, ParameterList &paramList,
      ParameterList &validParamList, const bool &allowBaseName = true) const;


protected:
  std::string name_ = "ANONYMOUS";

};


// /////////////////////////////////////////////////////
// Inline and Template Function Definitions


inline
ParameterListModifier& ParameterListModifier::setName( const std::string &name_in )
{
  name_ = name_in;
  return *this;
}


} // end of Teuchos namespace

#endif