Generic templated handle class. More...

#include <Teuchos_Handle.hpp>

Inheritance diagram for Teuchos::Handle< PointerType >:

Public Member Functions
	Handle ()

	Handle (const RCP< PointerType > &smartPtr)
	Construct with an existing RCP.
	Handle (Handleable< PointerType > *rawPtr)
	Construct with a raw pointer to a Handleable.
RCP< PointerType >	ptr () const
	Read/write access to the underlying smart pointer.
PointerType *	rawPtr () const
	Access to non-const raw pointer.

Detailed Description

template<typename PointerType>
class Teuchos::Handle< PointerType >

Generic templated handle class.

In writing derived types, it is usually simplest to use the TEUCHOS_HANDLE_CTORS macro to generate boilerplate constructor code.

There are two modes of construction: construction from an existing RCP,

 RCP<Base> r = rcp(new Derived(blahblah));
 Handle<Base> h = r;

and construction from a raw pointer,

 Handle<Base> h = new Derived(blahblah);

The second form makes the code slightly cleaner. Note that to use this second form, it is necessary that Derived implement the Handleable interface; this is necessary to avoid any implicit conversions from raw pointers to smart pointers.

Note that the first form must be used whenever the object being handled has been allocated on the stack.

Definition at line 135 of file Teuchos_Handle.hpp.