#include <Teuchos_Handle.hpp>
Public Member Functions | |
ConstHandle (const RCP< const PointerType > &ptr) | |
Construct with an existing RCP. | |
ConstHandle (const ConstHandleable< PointerType > *ptr) | |
Construct with a raw pointer to a ConstHandleable. This will make a call to rcp(), thus removing that call from the user interface. | |
const RCP< const PointerType > & | constPtr () const |
Read-only access to the underlying smart pointer. | |
const PointerType *const | rawPtr () |
Access to raw pointer. | |
Protected Member Functions | |
ConstHandle () | |
The empty ctor will only be called by Handle ctors. | |
void | setRcp (const RCP< PointerType > &ptr) |
This function is needed in Handle ctors. | |
RCP< PointerType > | nonConstPtr () const |
Protected non-const access to the underlying smart pointer. |
In writing derived types, it is usually simplest to use the TEUCHOS_CONST_HANDLE_CTORS macro to generate boilerplate constructor code.
There are two modes of construction: construction from an existing RCP,
RCP<const Base> r = rcp(new Derived(blahblah)); ConstHandle<Base> h = r;
ConstHandle<Base> h = new Derived(blahblah);
Note that the first form with rcp() must be used whenever the object being handled has been allocated on the stack (using rcp(ptr,false) of course).
Definition at line 66 of file Teuchos_Handle.hpp.
Teuchos::ConstHandle< PointerType >::ConstHandle | ( | const RCP< const PointerType > & | ptr | ) | [inline] |
Teuchos::ConstHandle< PointerType >::ConstHandle | ( | const ConstHandleable< PointerType > * | ptr | ) | [inline, explicit] |
Construct with a raw pointer to a ConstHandleable. This will make a call to rcp(), thus removing that call from the user interface.
Definition at line 73 of file Teuchos_Handle.hpp.
Teuchos::ConstHandle< PointerType >::ConstHandle | ( | ) | [inline, explicit, protected] |
The empty ctor will only be called by Handle ctors.
Definition at line 80 of file Teuchos_Handle.hpp.
const RCP<const PointerType>& Teuchos::ConstHandle< PointerType >::constPtr | ( | ) | const [inline] |
RCP<PointerType> Teuchos::ConstHandle< PointerType >::nonConstPtr | ( | ) | const [inline, protected] |
Protected non-const access to the underlying smart pointer.
This will be called by the nonConstPtr() method of the non-const Handle subclass
Definition at line 91 of file Teuchos_Handle.hpp.
const PointerType* const Teuchos::ConstHandle< PointerType >::rawPtr | ( | ) | [inline] |
void Teuchos::ConstHandle< PointerType >::setRcp | ( | const RCP< PointerType > & | ptr | ) | [inline, protected] |
This function is needed in Handle ctors.
The Handle ctors call the empty ConstHandle ctor and then set the pointer in the ConstHandle with a call to setRcp().
Definition at line 85 of file Teuchos_Handle.hpp.