ns3::Ptr< T > Class Template Reference
[Smart Pointer]

smart pointer class similar to boost::intrusive_ptr More...

#include <ptr.h>

List of all members.

Public Member Functions
	Ptr ()
	Ptr (T *ptr)
	Ptr (T *ptr, bool ref)
Related Functions
(Note that these are not member functions.)
template<typename T >
T *	PeekPointer (const Ptr< T > &p)
template<typename T >
T *	GetPointer (const Ptr< T > &p)

---

Detailed Description

template<typename T>
class ns3::Ptr< T >

smart pointer class similar to boost::intrusive_ptr

This smart-pointer class assumes that the underlying type provides a pair of Ref and Unref methods which are expected to increment and decrement the internal refcount of the object instance.

This implementation allows you to manipulate the smart pointer as if it was a normal pointer: you can compare it with zero, compare it against other pointers, assign zero to it, etc.

It is possible to extract the raw pointer from this smart pointer with the GetPointer and PeekPointer methods.

If you want to store a newed object into a smart pointer, we recommend you to use the Create template functions to create the object and store it in a smart pointer to avoid memory leaks. These functions are really small conveniance functions and their goal is just is save you a small bit of typing.

---

Constructor & Destructor Documentation

template<typename T >

ns3::Ptr< T >::Ptr

(

)

[inline]

Create an empty smart pointer

template<typename T>

ns3::Ptr< T >::Ptr

(

T *

ptr

)

[inline]

Parameters:

ptr

raw pointer to manage

Create a smart pointer which points to the object pointed to by the input raw pointer ptr. This method creates its own reference to the pointed object. The caller is responsible for Unref()'ing its own reference, and the smart pointer will eventually do the same, so that object is deleted if no more references to it remain.

template<typename T>

ns3::Ptr< T >::Ptr	(	T *	ptr,
		bool	ref
	)			[inline]

Parameters:

	ptr	raw pointer to manage
	ref	if set to true, this method calls Ref, otherwise, it does not call Ref.

Create a smart pointer which points to the object pointed to by the input raw pointer ptr.

---

Friends And Related Function Documentation

template<typename T >

T * GetPointer

(

const Ptr< T > &

p

)

[related]

Returns:

the pointer managed by this smart pointer.

The underlying refcount is incremented prior to returning to the caller so the caller is responsible for calling Unref himself.

References ns3::Ptr< T >::Acquire(), and ns3::Ptr< T >::m_ptr.

template<typename T >

T * PeekPointer

(

const Ptr< T > &

p

)

[related]

Returns:

the pointer managed by this smart pointer.

The underlying refcount is not incremented prior to returning to the caller so the caller is not responsible for calling Unref himself.

References ns3::Ptr< T >::m_ptr.

---

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

• src/core/ptr.h