Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_AbstractFactoryStd.hpp
Go to the documentation of this file.
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_ABSTRACT_FACTORY_STD_HPP
00043 #define TEUCHOS_ABSTRACT_FACTORY_STD_HPP
00044 
00045 #include "Teuchos_AbstractFactory.hpp"
00046 
00047 namespace Teuchos {
00048 
00052 template<class T_impl>
00053 class PostModNothing {
00054 public:
00056   void initialize(T_impl* p) const {} // required!
00057 };
00058 
00062 template<class T_impl>
00063 class AllocatorNew {
00064 public:
00066   typedef Teuchos::RCP<T_impl>  ptr_t;                         // required!
00068   const ptr_t allocate() const { return Teuchos::rcp(new T_impl()); }  // required!
00069 };
00070 
00138 template<class T_itfc, class T_impl
00139          ,class T_PostMod = PostModNothing<T_impl>
00140          ,class T_Allocator = AllocatorNew<T_impl>
00141         >
00142 class AbstractFactoryStd : public AbstractFactory<T_itfc> {
00143 public:
00144 
00145   typedef typename Teuchos::AbstractFactory<T_itfc>::obj_ptr_t   obj_ptr_t;  // RAB: 20030916: G++ 3.2 complains without this
00146 
00148   AbstractFactoryStd( const T_PostMod& post_mod = T_PostMod(), const T_Allocator& alloc = T_Allocator() );
00149 
00153   obj_ptr_t create() const;
00155 
00156 private:
00157   T_PostMod    post_mod_;
00158   T_Allocator  alloc_;
00159 
00160 };
00161 
00162 
00167 template<class T_itfc, class T_impl>
00168 RCP<const AbstractFactory<T_itfc> >
00169 abstractFactoryStd()
00170 {
00171   return rcp(
00172     new AbstractFactoryStd<T_itfc,T_impl,PostModNothing<T_impl>,AllocatorNew<T_impl> >()
00173     );
00174 }
00175 
00176 
00181 template<class T_itfc, class T_impl, class T_Allocator>
00182 RCP<const AbstractFactory<T_itfc> >
00183 abstractFactoryStd( const T_Allocator& alloc = T_Allocator() )
00184 {
00185   return rcp(
00186     new AbstractFactoryStd<T_itfc,T_impl,PostModNothing<T_impl>,T_Allocator>(
00187       PostModNothing<T_impl>(), alloc
00188       )
00189     );
00190 }
00191 
00192 
00193 // ///////////////////////////////////////////////////////
00194 // Template member definitions
00195 
00196 template<class T_itfc, class T_impl, class T_PostMod, class T_Allocator>
00197 inline
00198 AbstractFactoryStd<T_itfc,T_impl,T_PostMod,T_Allocator>::AbstractFactoryStd(
00199   const T_PostMod& post_mod, const T_Allocator& alloc
00200   )
00201   :post_mod_(post_mod)
00202   ,alloc_(alloc)
00203 {}
00204 
00205 template<class T_itfc, class T_impl, class T_PostMod, class T_Allocator>
00206 inline
00207 typename AbstractFactoryStd<T_itfc,T_impl,T_PostMod,T_Allocator>::obj_ptr_t
00208 AbstractFactoryStd<T_itfc,T_impl,T_PostMod,T_Allocator>::create() const
00209 {
00210   typename T_Allocator::ptr_t
00211     ptr = alloc_.allocate();
00212   post_mod_.initialize(ptr.get());
00213   return ptr;
00214 }
00215 
00216 } // end Teuchos
00217 
00218 #endif // TEUCHOS_ABSTRACT_FACTORY_STD_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines