Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_ParameterListAcceptor.hpp
1// @HEADER
2// *****************************************************************************
3// Teuchos: Common Tools Package
4//
5// Copyright 2004 NTESS and the Teuchos contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef TEUCHOS_PARAMETER_LIST_ACCEPTOR_HPP
11#define TEUCHOS_PARAMETER_LIST_ACCEPTOR_HPP
12
14
15namespace Teuchos {
16
17class ParameterList;
18class DependencySheet;
19template<class T> class RCP;
20
120class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterListAcceptor {
121public:
123 virtual ~ParameterListAcceptor ();
124
126
127
155 virtual void setParameterList (const RCP<ParameterList>& paramList) = 0;
156
167
179
181
183
193
204
213
215};
216
217} // end namespace Teuchos
218
219#endif // TEUCHOS_PARAMETER_LIST_ACCEPTOR_HPP
Teuchos header file which uses auto-configuration information to include necessary C++ headers.
A Dependency sheet keeps track of dependencies between various ParameterEntries.
Interface for objects that can accept a ParameterList.
virtual RCP< ParameterList > getNonconstParameterList()=0
Get a nonconst version of the parameter list that was set using setParameterList().
virtual RCP< const ParameterList > getParameterList() const
Get const version of the parameter list that was set using setParameterList().
virtual RCP< ParameterList > unsetParameterList()=0
Unset the parameter list that was set using setParameterList().
virtual void setParameterList(const RCP< ParameterList > &paramList)=0
Set parameters from a parameter list and return with default values.
virtual RCP< const DependencySheet > getDependencies() const
Rreturn a const DependencySheet of all the dependencies that should be applied to the ParameterList r...
virtual RCP< const ParameterList > getValidParameters() const
Return a ParameterList containing all of the valid parameters that this->setParameterList(....
A list of parameters of arbitrary type.
Smart reference counting pointer class for automatic garbage collection.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...