Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_ParameterListAcceptorDefaultBase.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_PARAMETER_LIST_ACCEPTOR_DEFAULT_BASE_HPP
43 #define TEUCHOS_PARAMETER_LIST_ACCEPTOR_DEFAULT_BASE_HPP
44 
45 #include "Teuchos_ParameterListAcceptor.hpp"
46 #include "Teuchos_RCP.hpp"
48 
49 
50 namespace Teuchos {
51 
52 
61 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterListAcceptorDefaultBase : virtual public ParameterListAcceptor {
62 public:
63 
66 
68  RCP<ParameterList> getNonconstParameterList();
70  RCP<ParameterList> unsetParameterList();
72  RCP<const ParameterList> getParameterList() const;
73 
75 
76 protected:
77 
80 
82  void setMyParamList( const RCP<ParameterList> &paramList );
83 
85  RCP<ParameterList> getMyNonconstParamList();
86 
88  RCP<const ParameterList> getMyParamList() const;
89 
91 
92 private:
93 
94  RCP<ParameterList> paramList_;
95 
96 };
97 
98 
99 //
100 // Inline definitions
101 //
102 
103 
104 inline
106  const RCP<ParameterList> &paramList
107  )
108 {
109  paramList_ = paramList;
110 }
111 
112 
113 inline
116 {
117  return paramList_;
118 }
119 
120 
121 inline
124 {
125  return paramList_;
126 }
127 
128 
129 } // end namespace Teuchos
130 
131 
132 #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.
Smart reference counting pointer class for automatic garbage collection.
Reference-counted pointer class and non-member templated function implementations.