Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_ParameterListAcceptorDefaultBase.hpp
Go to the documentation of this file.
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_DEFAULT_BASE_HPP
11 #define TEUCHOS_PARAMETER_LIST_ACCEPTOR_DEFAULT_BASE_HPP
12 
14 #include "Teuchos_RCP.hpp"
16 
17 
18 namespace Teuchos {
19 
20 
30 public:
31 
34 
36  RCP<ParameterList> getNonconstParameterList();
38  RCP<ParameterList> unsetParameterList();
40  RCP<const ParameterList> getParameterList() const;
41 
43 
44 protected:
45 
48 
50  void setMyParamList( const RCP<ParameterList> &paramList );
51 
53  RCP<ParameterList> getMyNonconstParamList();
54 
56  RCP<const ParameterList> getMyParamList() const;
57 
59 
60 private:
61 
63 
64 };
65 
66 
67 //
68 // Inline definitions
69 //
70 
71 
72 inline
74  const RCP<ParameterList> &paramList
75  )
76 {
77  paramList_ = paramList;
78 }
79 
80 
81 inline
84 {
85  return paramList_;
86 }
87 
88 
89 inline
92 {
93  return paramList_;
94 }
95 
96 
97 } // end namespace Teuchos
98 
99 
100 #endif // TEUCHOS_PARAMETER_LIST_ACCEPTOR_DEFAULT_BASE_HPP
Templated Parameter List class.
Intermediate node base class for objects that accept parameter lists that implements some of the need...
void setMyParamList(const RCP< ParameterList > &paramList)
Interface for objects that can accept a ParameterList.
#define TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
Smart reference counting pointer class for automatic garbage collection.
Reference-counted pointer class and non-member templated function implementations.