Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Sacado::Handle< T > Class Template Reference

A generic handle class. More...

#include <Sacado_Handle.hpp>

Inheritance diagram for Sacado::Handle< T >:
Inheritance graph
[legend]

Public Member Functions

 Handle (T *p)
 Create new handle from pointer p.
 
 Handle (const Handle &h)
 Copy handle.
 
 ~Handle ()
 Destroy handle.
 
Tget ()
 Return pointer to underlying data.
 
const Tget () const
 Return pointer to underlying data.
 
void Assign (const Handle &h)
 Assign to handle h as its own copy.
 
void makeOwnCopy ()
 Make handle have its own copy of rep.
 
Handleoperator= (const Handle &h)
 Assignment operator.
 
Toperator-> () const
 Dereference.
 
const Toperator* () const
 Dereference.
 
Toperator* ()
 Dereference.
 

Private Member Functions

void decrementRef ()
 Decrement reference.
 

Private Attributes

Trep
 Pointer to data.
 
int * count
 Reference count.
 

Detailed Description

template<typename T>
class Sacado::Handle< T >

A generic handle class.

Definition at line 41 of file Sacado_Handle.hpp.

Constructor & Destructor Documentation

◆ Handle() [1/2]

template<typename T >
Sacado::Handle< T >::Handle ( T p)
inline

Create new handle from pointer p.

Definition at line 45 of file Sacado_Handle.hpp.

◆ Handle() [2/2]

template<typename T >
Sacado::Handle< T >::Handle ( const Handle< T > &  h)
inline

Copy handle.

Definition at line 48 of file Sacado_Handle.hpp.

◆ ~Handle()

template<typename T >
Sacado::Handle< T >::~Handle ( )
inline

Destroy handle.

Definition at line 51 of file Sacado_Handle.hpp.

Member Function Documentation

◆ get() [1/2]

template<typename T >
T * Sacado::Handle< T >::get ( )
inline

Return pointer to underlying data.

Definition at line 54 of file Sacado_Handle.hpp.

◆ get() [2/2]

template<typename T >
const T * Sacado::Handle< T >::get ( ) const
inline

Return pointer to underlying data.

Definition at line 57 of file Sacado_Handle.hpp.

◆ Assign()

template<typename T >
void Sacado::Handle< T >::Assign ( const Handle< T > &  h)
inline

Assign to handle h as its own copy.

Definition at line 60 of file Sacado_Handle.hpp.

◆ makeOwnCopy()

template<typename T >
void Sacado::Handle< T >::makeOwnCopy ( )
inline

Make handle have its own copy of rep.

Definition at line 67 of file Sacado_Handle.hpp.

◆ operator=()

template<typename T >
Handle & Sacado::Handle< T >::operator= ( const Handle< T > &  h)
inline

Assignment operator.

Definition at line 78 of file Sacado_Handle.hpp.

◆ operator->()

template<typename T >
T * Sacado::Handle< T >::operator-> ( ) const
inline

Dereference.

Definition at line 89 of file Sacado_Handle.hpp.

◆ operator*() [1/2]

template<typename T >
const T & Sacado::Handle< T >::operator* ( ) const
inline

Dereference.

Definition at line 92 of file Sacado_Handle.hpp.

◆ operator*() [2/2]

template<typename T >
T & Sacado::Handle< T >::operator* ( )
inline

Dereference.

Definition at line 95 of file Sacado_Handle.hpp.

◆ decrementRef()

template<typename T >
void Sacado::Handle< T >::decrementRef ( )
inlineprivate

Decrement reference.

Definition at line 106 of file Sacado_Handle.hpp.

Member Data Documentation

◆ rep

template<typename T >
T* Sacado::Handle< T >::rep
private

Pointer to data.

Definition at line 100 of file Sacado_Handle.hpp.

◆ count

template<typename T >
int* Sacado::Handle< T >::count
private

Reference count.

Definition at line 103 of file Sacado_Handle.hpp.


The documentation for this class was generated from the following file: