ACE_Utils::Auto_Functor< X, Functor > Class Template Reference

Helper template to implement auto_ptr<>-like classes, but executing a functor in the destructor, instead of always deleting things. More...

#include <Auto_Functor.h>

List of all members.

Public Types
typedef X	element_type
typedef Functor	functor_type
Public Member Functions
	Auto_Functor (X *p=0, Functor functor=Functor())
	Constructor.
	Auto_Functor (Auto_Functor &rhs)
Auto_Functor< X, Functor > &	operator= (Auto_Functor &rhs)
template<typename Y >
	Auto_Functor (Auto_Functor< Y, Functor > &rhs)
template<typename Y >
Auto_Functor< X, Functor > &	operator= (Auto_Functor< Y, Functor > &rhs)
	~Auto_Functor ()
X &	operator* () const
X *	operator-> () const
X *	get ()
X *	release ()
void	reset (X *p=0)
void	reset (X *p, Functor f)
Functor const &	functor () const
	Auto_Functor (Auto_Functor_Ref< X, Functor > rhs)
Auto_Functor< X, Functor > &	operator= (Auto_Functor_Ref< X, Functor > rhs)
template<typename Y >
	operator Auto_Functor_Ref< Y, Functor > ()
template<typename Y >
	operator Auto_Functor< Y, Functor > ()
Private Attributes
X *	p_
Functor	f_

---

Detailed Description

template<typename X, typename Functor>
class ACE_Utils::Auto_Functor< X, Functor >

Helper template to implement auto_ptr<>-like classes, but executing a functor in the destructor, instead of always deleting things.

The functor is called in the destructor, and it must implement:

Functor() throw();
Functor(Functor const &) throw();
Functor & operator=(Functor const &) throw();
void operator()(X * p) throw();

Definition at line 58 of file Auto_Functor.h.

---

Member Typedef Documentation

template<typename X, typename Functor>

typedef X ACE_Utils::Auto_Functor< X, Functor >::element_type

Definition at line 61 of file Auto_Functor.h.

template<typename X, typename Functor>

typedef Functor ACE_Utils::Auto_Functor< X, Functor >::functor_type

Definition at line 62 of file Auto_Functor.h.

---

Constructor & Destructor Documentation

template<typename X , typename Functor >

ACE_Utils::Auto_Functor< X, Functor >::Auto_Functor	(	X *	p = 0,
		Functor	functor = Functor()
	)			[inline, explicit]

Constructor.

Definition at line 16 of file Auto_Functor.inl.

  : p_(p)
  , f_(f)
{
}

template<typename X , typename Functor >

ACE_Utils::Auto_Functor< X, Functor >::Auto_Functor

(

Auto_Functor< X, Functor > &

rhs

)

[inline]

Definition at line 23 of file Auto_Functor.inl.

  : p_(rhs.release())
  , f_(rhs.f_)
{
}

template<typename X , typename Functor >

template<typename Y >

ACE_Utils::Auto_Functor< X, Functor >::Auto_Functor

(

Auto_Functor< Y, Functor > &

rhs

)

[inline]

Definition at line 40 of file Auto_Functor.inl.

  : p_(rhs.release())
  , f_(rhs.f_)
{
}

template<typename X , typename Functor >

ACE_Utils::Auto_Functor< X, Functor >::~Auto_Functor

(

)

Definition at line 15 of file Auto_Functor.cpp.

{
  reset(0);
}

template<typename X , typename Functor >

ACE_Utils::Auto_Functor< X, Functor >::Auto_Functor

(

Auto_Functor_Ref< X, Functor >

rhs

)

[inline]

Definition at line 92 of file Auto_Functor.inl.

  : p_(rhs.p_)
  , f_(rhs.f_)
{
}

---

Member Function Documentation

template<typename X , typename Functor >

Functor const & ACE_Utils::Auto_Functor< X, Functor >::functor

(

)

const [inline]

Definition at line 86 of file Auto_Functor.inl.

{
  return f_;
}

template<typename X , typename Functor >

X * ACE_Utils::Auto_Functor< X, Functor >::get

(

)

[inline]

Definition at line 70 of file Auto_Functor.inl.

{
  return p_;
}

template<typename X, typename Functor>

template<typename Y >

ACE_Utils::Auto_Functor< X, Functor >::operator Auto_Functor< Y, Functor >

(

)

template<typename X, typename Functor>

template<typename Y >

ACE_Utils::Auto_Functor< X, Functor >::operator Auto_Functor_Ref< Y, Functor >

(

)

template<typename X , typename Functor >

X & ACE_Utils::Auto_Functor< X, Functor >::operator*

(

)

const [inline]

Definition at line 56 of file Auto_Functor.inl.

{
  return *p_;
}

template<typename X , typename Functor >

X * ACE_Utils::Auto_Functor< X, Functor >::operator->

(

)

const [inline]

Definition at line 63 of file Auto_Functor.inl.

{
  return p_;
}

template<typename X , typename Functor >

ACE_Utils::Auto_Functor< X, Functor > & ACE_Utils::Auto_Functor< X, Functor >::operator=

(

Auto_Functor_Ref< X, Functor >

rhs

)

[inline]

Definition at line 100 of file Auto_Functor.inl.

{
  if(rhs.p_ != p_)
  {
    reset(rhs.p_);
    f_ = rhs.f_;
  }
  return *this;
}

template<typename X , typename Functor >

template<typename Y >

ACE_Utils::Auto_Functor< X, Functor > & ACE_Utils::Auto_Functor< X, Functor >::operator=

(

Auto_Functor< Y, Functor > &

rhs

)

[inline]

Definition at line 48 of file Auto_Functor.inl.

{
  reset(rhs.release());
  return *this;
}

template<typename X , typename Functor >

ACE_Utils::Auto_Functor< X, Functor > & ACE_Utils::Auto_Functor< X, Functor >::operator=

(

Auto_Functor< X, Functor > &

rhs

)

[inline]

Definition at line 31 of file Auto_Functor.inl.

{
  reset(rhs.release());
  f_ = rhs.f_;
  return *this;
}

template<typename X , typename Functor >

X * ACE_Utils::Auto_Functor< X, Functor >::release

(

)

[inline]

Definition at line 77 of file Auto_Functor.inl.

{
  X * tmp = p_;
  p_ = 0;
  return tmp;
}

template<typename X , typename Functor >

void ACE_Utils::Auto_Functor< X, Functor >::reset

(

X *

p = 0

)

Definition at line 21 of file Auto_Functor.cpp.

{
  if(p_ != 0)
  {
    f_(p_);
  }
  p_ = p;
}

template<typename X , typename Functor >

void ACE_Utils::Auto_Functor< X, Functor >::reset	(	X *	p,
		Functor	f
	)

Definition at line 31 of file Auto_Functor.cpp.

{
  reset(p);
  f_ = f;
}

---

Member Data Documentation

template<typename X, typename Functor>

Functor ACE_Utils::Auto_Functor< X, Functor >::f_ [private]

Definition at line 111 of file Auto_Functor.h.

template<typename X, typename Functor>

X* ACE_Utils::Auto_Functor< X, Functor >::p_ [private]

Definition at line 109 of file Auto_Functor.h.

---

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

• Auto_Functor.h
• Auto_Functor.cpp
• Auto_Functor.inl