Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_ParameterListAcceptor.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_HPP
43 #define TEUCHOS_PARAMETER_LIST_ACCEPTOR_HPP
44 
45 #include "Teuchos_ConfigDefs.hpp"
46 
47 namespace Teuchos {
48 
49 class ParameterList;
50 class DependencySheet;
51 template<class T> class RCP;
52 
152 class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterListAcceptor {
153 public:
155  virtual ~ParameterListAcceptor ();
156 
158 
159 
187  virtual void setParameterList (const RCP<ParameterList>& paramList) = 0;
188 
198  virtual RCP<ParameterList> getNonconstParameterList() = 0;
199 
210  virtual RCP<ParameterList> unsetParameterList() = 0;
211 
213 
215 
224  virtual RCP<const ParameterList> getParameterList() const;
225 
235  virtual RCP<const ParameterList> getValidParameters() const;
236 
244  virtual RCP<const DependencySheet> getDependencies() const;
245 
247 };
248 
249 } // end namespace Teuchos
250 
251 #endif // TEUCHOS_PARAMETER_LIST_ACCEPTOR_HPP
Teuchos header file which uses auto-configuration information to include necessary C++ headers...
Interface for objects that can accept a ParameterList.
Smart reference counting pointer class for automatic garbage collection.