Sacado Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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. More...
 
 Handle (const Handle &h)
 Copy handle. More...
 
 ~Handle ()
 Destroy handle. More...
 
Tget ()
 Return pointer to underlying data. More...
 
const Tget () const
 Return pointer to underlying data. More...
 
void Assign (const Handle &h)
 Assign to handle h as its own copy. More...
 
void makeOwnCopy ()
 Make handle have its own copy of rep. More...
 
Handleoperator= (const Handle &h)
 Assignment operator. More...
 
Toperator-> () const
 Dereference. More...
 
const Toperator* () const
 Dereference. More...
 
Toperator* ()
 Dereference. More...
 

Private Member Functions

void decrementRef ()
 Decrement reference. More...
 

Private Attributes

Trep
 Pointer to data. More...
 
int * count
 Reference count. More...
 

Detailed Description

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

A generic handle class.

Definition at line 19 of file Sacado_Handle.hpp.

Constructor & Destructor Documentation

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

Create new handle from pointer p.

Definition at line 23 of file Sacado_Handle.hpp.

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

Copy handle.

Definition at line 26 of file Sacado_Handle.hpp.

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

Destroy handle.

Definition at line 29 of file Sacado_Handle.hpp.

Member Function Documentation

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

Return pointer to underlying data.

Definition at line 32 of file Sacado_Handle.hpp.

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

Return pointer to underlying data.

Definition at line 35 of file Sacado_Handle.hpp.

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

Assign to handle h as its own copy.

Definition at line 38 of file Sacado_Handle.hpp.

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

Make handle have its own copy of rep.

Definition at line 45 of file Sacado_Handle.hpp.

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

Assignment operator.

Definition at line 56 of file Sacado_Handle.hpp.

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

Dereference.

Definition at line 67 of file Sacado_Handle.hpp.

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

Dereference.

Definition at line 70 of file Sacado_Handle.hpp.

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

Dereference.

Definition at line 73 of file Sacado_Handle.hpp.

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

Decrement reference.

Definition at line 84 of file Sacado_Handle.hpp.

Member Data Documentation

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

Pointer to data.

Definition at line 78 of file Sacado_Handle.hpp.

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

Reference count.

Definition at line 81 of file Sacado_Handle.hpp.


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