Teuchos - Trilinos Tools Package Version of the Day
Teuchos_ParameterListAcceptorDefaultBase.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_PARAMETER_LIST_ACCEPTOR_DEFAULT_BASE_HPP
00043 #define TEUCHOS_PARAMETER_LIST_ACCEPTOR_DEFAULT_BASE_HPP
00044 
00045 #include "Teuchos_ParameterListAcceptor.hpp"
00046 #include "Teuchos_RCP.hpp"
00047 #include "Teuchos_ParameterList.hpp"
00048 
00049 
00050 namespace Teuchos {
00051 
00052 
00061 class ParameterListAcceptorDefaultBase : virtual public ParameterListAcceptor {
00062 public:
00063 
00066 
00068   RCP<ParameterList> getNonconstParameterList();
00070   RCP<ParameterList> unsetParameterList();
00072   RCP<const ParameterList> getParameterList() const;
00073 
00075 
00076 protected:
00077 
00080 
00082   void setMyParamList( const RCP<ParameterList> &paramList );
00083 
00085   RCP<ParameterList> getMyNonconstParamList();
00086 
00088   RCP<const ParameterList> getMyParamList() const;
00089 
00091 
00092 private:
00093 
00094   RCP<ParameterList> paramList_;
00095 
00096 };
00097 
00098 
00099 //
00100 // Inline definitions
00101 //
00102 
00103 
00104 inline
00105 void ParameterListAcceptorDefaultBase::setMyParamList(
00106   const RCP<ParameterList> &paramList
00107   )
00108 {
00109   paramList_ = paramList;
00110 }
00111 
00112 
00113 inline
00114 RCP<ParameterList>
00115 ParameterListAcceptorDefaultBase::getMyNonconstParamList()
00116 {
00117   return paramList_;
00118 }
00119 
00120 
00121 inline
00122 RCP<const ParameterList>
00123 ParameterListAcceptorDefaultBase::getMyParamList() const
00124 {
00125   return paramList_;
00126 }
00127 
00128 
00129 } // end namespace Teuchos
00130 
00131 
00132 #endif // TEUCHOS_PARAMETER_LIST_ACCEPTOR_DEFAULT_BASE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines