Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Related Functions | List of all members
Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc > Class Template Reference

A deallocator class that wraps a simple value object and delegates to another deallocator object. More...

#include <Teuchos_RCPDecl.hpp>

Public Types

typedef Dealloc::ptr_t ptr_t
 

Public Member Functions

 EmbeddedObjDealloc (const Embedded &embedded, EPrePostDestruction prePostDestroy, Dealloc dealloc)
 
void setObj (const Embedded &embedded)
 
const Embedded & getObj () const
 
Embedded & getNonconstObj ()
 
void free (T *ptr)
 

Private Member Functions

 EmbeddedObjDealloc ()
 

Private Attributes

Embedded embedded_
 
EPrePostDestruction prePostDestroy_
 
Dealloc dealloc_
 

Related Functions

(Note that these are not member functions.)

template<class T , class Embedded >
EmbeddedObjDealloc< T,
Embedded, DeallocDelete< T > > 		embeddedObjDeallocDelete (const Embedded &embedded, EPrePostDestruction prePostDestroy)
 Create a dealocator with an embedded object using delete. More...
 
template<class T , class Embedded >
EmbeddedObjDealloc< T,
Embedded, DeallocArrayDelete
< T > > 		embeddedObjDeallocArrayDelete (const Embedded &embedded, EPrePostDestruction prePostDestroy)
 Create a dealocator with an embedded object using delete []. More...
 

Detailed Description

template<class T, class Embedded, class Dealloc>
class Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >

A deallocator class that wraps a simple value object and delegates to another deallocator object.

The type Embedded must be a true value object with a default constructor, a copy constructor, and an assignment operator.

Definition at line 1113 of file Teuchos_RCPDecl.hpp.

Member Typedef Documentation

template<class T, class Embedded, class Dealloc>
typedef Dealloc::ptr_t Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::ptr_t

Definition at line 1116 of file Teuchos_RCPDecl.hpp.

Constructor & Destructor Documentation

template<class T, class Embedded, class Dealloc>
Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::EmbeddedObjDealloc ( const Embedded &  embedded,
EPrePostDestruction  prePostDestroy,
Dealloc  dealloc 
)
inline

Definition at line 1117 of file Teuchos_RCPDecl.hpp.

template<class T, class Embedded, class Dealloc>
Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::EmbeddedObjDealloc ( )
private

Member Function Documentation

template<class T, class Embedded, class Dealloc>
void Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::setObj ( const Embedded &  embedded)
inline

Definition at line 1122 of file Teuchos_RCPDecl.hpp.

template<class T, class Embedded, class Dealloc>
const Embedded& Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::getObj ( ) const
inline

Definition at line 1123 of file Teuchos_RCPDecl.hpp.

template<class T, class Embedded, class Dealloc>
Embedded& Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::getNonconstObj ( )
inline

Definition at line 1124 of file Teuchos_RCPDecl.hpp.

template<class T, class Embedded, class Dealloc>
void Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::free ( T *  ptr)
inline

Definition at line 1125 of file Teuchos_RCPDecl.hpp.

Friends And Related Function Documentation

template<class T , class Embedded >
EmbeddedObjDealloc< T, Embedded, DeallocDelete< T > > embeddedObjDeallocDelete ( const Embedded &  embedded,
EPrePostDestruction  prePostDestroy 
)
related

Create a dealocator with an embedded object using delete.

Definition at line 1147 of file Teuchos_RCPDecl.hpp.

template<class T , class Embedded >
EmbeddedObjDealloc< T, Embedded, DeallocArrayDelete< T > > embeddedObjDeallocArrayDelete ( const Embedded &  embedded,
EPrePostDestruction  prePostDestroy 
)
related

Create a dealocator with an embedded object using delete [].

Definition at line 1160 of file Teuchos_RCPDecl.hpp.

Member Data Documentation

template<class T, class Embedded, class Dealloc>
Embedded Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::embedded_
private

Definition at line 1134 of file Teuchos_RCPDecl.hpp.

template<class T, class Embedded, class Dealloc>
EPrePostDestruction Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::prePostDestroy_
private

Definition at line 1135 of file Teuchos_RCPDecl.hpp.

template<class T, class Embedded, class Dealloc>
Dealloc Teuchos::EmbeddedObjDealloc< T, Embedded, Dealloc >::dealloc_
private

Definition at line 1136 of file Teuchos_RCPDecl.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5