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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00025 //
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TEUCHOS_CONST_NONCONST_OBJECT_CONTAINER_HPP
00030 #define TEUCHOS_CONST_NONCONST_OBJECT_CONTAINER_HPP
00031 
00032 #include "Teuchos_RCP.hpp"
00033 
00034 
00035 namespace Teuchos {
00036 
00037 
00261 template<class ObjType>
00262 class ConstNonconstObjectContainer {
00263 public:
00265   ConstNonconstObjectContainer()
00266     :constObj_(null),isConst_(true) {}
00268   ConstNonconstObjectContainer( const RCP<ObjType> &obj )
00269     { initialize(obj); }
00271   ConstNonconstObjectContainer( const RCP<const ObjType> &obj )
00272     { initialize(obj); }
00275   void initialize( const RCP<ObjType> &obj )
00276     {
00277       TEST_FOR_EXCEPTION(is_null(obj), NullReferenceError, "Error!");
00278       constObj_ = obj;
00279       isConst_ = false;
00280     }
00283   void initialize( const RCP<const ObjType> &obj )
00284     {
00285       TEST_FOR_EXCEPTION(is_null(obj), NullReferenceError, "Error!");
00286       constObj_ = obj; 
00287       isConst_ = true;
00288     }
00290   void uninitialize()
00291     { constObj_=null; isConst_=true; }
00293   bool isConst() const
00294     { return isConst_; }
00309   RCP<ObjType> getNonconstObj() const
00310     {
00311       TEST_FOR_EXCEPTION(
00312         constObj_.get() && isConst_, NonconstAccessError,
00313         "Error, the object of reference type \""<<TypeNameTraits<ObjType>::name()
00314         <<"\" was given as a const-only object and non-const access is not allowed."
00315         );
00316       return rcp_const_cast<ObjType>(constObj_);
00317     }
00323   RCP<const ObjType> getConstObj() const
00324     { return constObj_; }
00326   RCP<const ObjType> operator()() const
00327     { return getConstObj(); }
00334   const ObjType* operator->() const
00335     { return &*getConstObj(); } // Does assert also!
00342   const ObjType& operator*() const
00343     { return *getConstObj(); }
00345   operator RCP<const ObjType>() const
00346     { return getConstObj(); }
00347 
00348 private:
00349   RCP<const ObjType> constObj_;
00350   bool isConst_;
00351 };
00352 
00353 
00358 template<class T>
00359 bool is_null( const ConstNonconstObjectContainer<T> &p )
00360 { return is_null(p.getConstObj()); }
00361 
00362 
00367 template<class T>
00368 bool nonnull( const ConstNonconstObjectContainer<T> &p )
00369 { return nonnull(p.getConstObj()); }
00370 
00371 
00372 } // namespace Teuchos
00373 
00374 
00375 #endif // TEUCHOS_CONST_NONCONST_OBJECT_CONTAINER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines