Teuchos - Trilinos Tools Package
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
parameterlist
src
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
13
#include "
Teuchos_ConfigDefs.hpp
"
14
15
namespace
Teuchos
{
16
17
class
ParameterList
;
18
class
DependencySheet
;
19
template
<
class
T>
class
RCP
;
20
120
class
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
ParameterListAcceptor
{
121
public
:
123
virtual
~ParameterListAcceptor
();
124
126
127
155
virtual
void
setParameterList
(
const
RCP<ParameterList>
& paramList) = 0;
156
166
virtual
RCP<ParameterList>
getNonconstParameterList
() = 0;
167
178
virtual
RCP<ParameterList>
unsetParameterList
() = 0;
179
181
183
192
virtual
RCP<const ParameterList>
getParameterList
()
const
;
193
203
virtual
RCP<const ParameterList>
getValidParameters
()
const
;
204
212
virtual
RCP<const DependencySheet>
getDependencies
()
const
;
213
215
};
216
217
}
// end namespace Teuchos
218
219
#endif
// TEUCHOS_PARAMETER_LIST_ACCEPTOR_HPP
Teuchos_ConfigDefs.hpp
Teuchos header file which uses auto-configuration information to include necessary C++ headers.
Teuchos::DependencySheet
A Dependency sheet keeps track of dependencies between various ParameterEntries.
Definition
Teuchos_DependencySheet.hpp:27
Teuchos::ParameterListAcceptor
Interface for objects that can accept a ParameterList.
Definition
Teuchos_ParameterListAcceptor.hpp:120
Teuchos::ParameterListAcceptor::getNonconstParameterList
virtual RCP< ParameterList > getNonconstParameterList()=0
Get a nonconst version of the parameter list that was set using setParameterList().
Teuchos::ParameterListAcceptor::getParameterList
virtual RCP< const ParameterList > getParameterList() const
Get const version of the parameter list that was set using setParameterList().
Definition
Teuchos_ParameterListAcceptor.cpp:24
Teuchos::ParameterListAcceptor::unsetParameterList
virtual RCP< ParameterList > unsetParameterList()=0
Unset the parameter list that was set using setParameterList().
Teuchos::ParameterListAcceptor::setParameterList
virtual void setParameterList(const RCP< ParameterList > ¶mList)=0
Set parameters from a parameter list and return with default values.
Teuchos::ParameterListAcceptor::getDependencies
virtual RCP< const DependencySheet > getDependencies() const
Rreturn a const DependencySheet of all the dependencies that should be applied to the ParameterList r...
Definition
Teuchos_ParameterListAcceptor.cpp:37
Teuchos::ParameterListAcceptor::getValidParameters
virtual RCP< const ParameterList > getValidParameters() const
Return a ParameterList containing all of the valid parameters that this->setParameterList(....
Definition
Teuchos_ParameterListAcceptor.cpp:31
Teuchos::ParameterList
A list of parameters of arbitrary type.
Definition
Teuchos_ParameterList.hpp:101
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition
Teuchos_RCPDecl.hpp:397
Teuchos
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos,...
Generated by
1.17.0