Teuchos::OpaqueWrapperWithFree< Opaque, OpaqueFree > Class Template Reference

Subclass for wrapped opaque objects with a free function. More...

#include <Teuchos_OpaqueWrapper.hpp>

Inheritance diagram for Teuchos::OpaqueWrapperWithFree< Opaque, OpaqueFree >:

[legend]

Collaboration diagram for Teuchos::OpaqueWrapperWithFree< Opaque, OpaqueFree >:

[legend]

List of all members.

Public Member Functions
	OpaqueWrapperWithFree (Opaque opaque, OpaqueFree opaqueFree)
	~OpaqueWrapperWithFree ()

---

Detailed Description

template<class Opaque, class OpaqueFree>
class Teuchos::OpaqueWrapperWithFree< Opaque, OpaqueFree >

Subclass for wrapped opaque objects with a free function.

This subclass allows a client to easily wrap any opaque object that needs a function to free it. This function (or function object) must be callable as:

  opaqueFree(&opaque);

Again, this is typical for the opaque objects implemented in MPI for instance. For example, in order to delete an MPI_Comm object created by the user (not MPI_COMM_WORLD), you must call the function MPI_Comm_free().

Definition at line 142 of file Teuchos_OpaqueWrapper.hpp.

---

Constructor & Destructor Documentation

template<class Opaque , class OpaqueFree >

Teuchos::OpaqueWrapperWithFree< Opaque, OpaqueFree >::OpaqueWrapperWithFree	(	Opaque	opaque,
		OpaqueFree	opaqueFree
	)			[inline]

Definition at line 144 of file Teuchos_OpaqueWrapper.hpp.

template<class Opaque , class OpaqueFree >

Teuchos::OpaqueWrapperWithFree< Opaque, OpaqueFree >::~OpaqueWrapperWithFree

(

)

[inline]

Definition at line 147 of file Teuchos_OpaqueWrapper.hpp.

---

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

• Teuchos_OpaqueWrapper.hpp