Teuchos_Handle.hpp

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_HANDLE_HPP
#define TEUCHOS_HANDLE_HPP

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_Handleable.hpp"

namespace Teuchos 
{

  template <typename PointerType> 
  class ConstHandle : public virtual Describable
  {
  public:
    ConstHandle(const RefCountPtr<const PointerType>& ptr) : ptr_(ptr) {;}
    explicit ConstHandle(const ConstHandleable<PointerType>* ptr) : ptr_(ptr->getConstRcp()) {;}
    const RefCountPtr<const PointerType>& constPtr() const {return ptr_;}
    const PointerType * const rawPtr() {return this->constPtr().get();}
  protected:
    explicit ConstHandle() : ptr_() {;}
    void setRcp(const RefCountPtr<PointerType>& ptr) 
    {ptr_=rcp_const_cast<const PointerType>(ptr);}
    RefCountPtr<PointerType> nonConstPtr() const
    {return rcp_const_cast<PointerType>(ptr_);}
  private:
    RefCountPtr<const PointerType> ptr_;
  };

  template <typename PointerType> 
  class Handle : public virtual ConstHandle<PointerType>
  {
  public:
    Handle()
      : ConstHandle<PointerType>() {}
    Handle(const RefCountPtr<PointerType>& smartPtr)
      : ConstHandle<PointerType>() 
    {
      /* \brief We need to set the rcp in the base class */
      setRcp(smartPtr);
    }
    explicit Handle(Handleable<PointerType>* rawPtr)
      : ConstHandle<PointerType>()
    {
      /* \brief We need to set the rcp in the base class. */
      setRcp(rawPtr->getRcp());
    }
    RefCountPtr<PointerType> ptr() const {return this->nonConstPtr();}
    PointerType* rawPtr() const {return this->nonConstPtr().get();}
  };

} // namespace Teuchos

#define TEUCHOS_HANDLE_CTORS(handle, contents) \
handle() : Teuchos::Handle<contents >() {;} \
handle(Teuchos::Handleable<contents >* rawPtr) : Teuchos::Handle<contents >(rawPtr) {;} \
handle(const Teuchos::RefCountPtr<contents >& smartPtr) : Teuchos::Handle<contents >(smartPtr){;}

#define TEUCHOS_CONST_HANDLE_CTORS(handle, contents) \
handle() : Teuchos::ConstHandle<contents >() {;} \
handle(const Teuchos::ConstHandleable<contents >* rawPtr) : Teuchos::ConstHandle<contents >(rawPtr) {;} \
handle(const Teuchos::RefCountPtr<const contents >& smartPtr) : Teuchos::ConstHandle<contents >(smartPtr){;}

#endif // TEUCHOS_CONSTHANDLE_HPP

---