Teuchos - Trilinos Tools Package Version of the Day
Teuchos_ConstNonconstObjectContainer.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_CONST_NONCONST_OBJECT_CONTAINER_HPP
00043 #define TEUCHOS_CONST_NONCONST_OBJECT_CONTAINER_HPP
00044 
00045 #include "Teuchos_RCP.hpp"
00046 
00047 
00048 namespace Teuchos {
00049 
00050 
00274 template<class ObjType>
00275 class ConstNonconstObjectContainer {
00276 public:
00278   ConstNonconstObjectContainer()
00279     :constObj_(null),isConst_(true) {}
00281   ConstNonconstObjectContainer( const RCP<ObjType> &obj )
00282     { initialize(obj); }
00284   ConstNonconstObjectContainer( const RCP<const ObjType> &obj )
00285     { initialize(obj); }
00288   void initialize( const RCP<ObjType> &obj )
00289     {
00290       TEST_FOR_EXCEPTION(is_null(obj), NullReferenceError, "Error!");
00291       constObj_ = obj;
00292       isConst_ = false;
00293     }
00296   void initialize( const RCP<const ObjType> &obj )
00297     {
00298       TEST_FOR_EXCEPTION(is_null(obj), NullReferenceError, "Error!");
00299       constObj_ = obj; 
00300       isConst_ = true;
00301     }
00303   void uninitialize()
00304     { constObj_=null; isConst_=true; }
00306   bool isConst() const
00307     { return isConst_; }
00322   RCP<ObjType> getNonconstObj() const
00323     {
00324       TEST_FOR_EXCEPTION(
00325         constObj_.get() && isConst_, NonconstAccessError,
00326         "Error, the object of reference type \""<<TypeNameTraits<ObjType>::name()
00327         <<"\" was given as a const-only object and non-const access is not allowed."
00328         );
00329       return rcp_const_cast<ObjType>(constObj_);
00330     }
00336   RCP<const ObjType> getConstObj() const
00337     { return constObj_; }
00339   RCP<const ObjType> operator()() const
00340     { return getConstObj(); }
00347   const ObjType* operator->() const
00348     { return &*getConstObj(); } // Does assert also!
00355   const ObjType& operator*() const
00356     { return *getConstObj(); }
00358   operator RCP<const ObjType>() const
00359     { return getConstObj(); }
00360 
00361 private:
00362   RCP<const ObjType> constObj_;
00363   bool isConst_;
00364 };
00365 
00366 
00371 template<class T>
00372 bool is_null( const ConstNonconstObjectContainer<T> &p )
00373 { return is_null(p.getConstObj()); }
00374 
00375 
00380 template<class T>
00381 bool nonnull( const ConstNonconstObjectContainer<T> &p )
00382 { return nonnull(p.getConstObj()); }
00383 
00384 
00385 } // namespace Teuchos
00386 
00387 
00388 #endif // TEUCHOS_CONST_NONCONST_OBJECT_CONTAINER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines