RWTOnlyPointer< Body > Class Template Reference
[Smart Pointers]

Simplifies the use of pointers that refer to objects on the heap, automatically destroying the object when the pointer object is itself destroyed. More...

#include <rw/pointer/RWTOnlyPointer.h>

Inheritance diagram for RWTOnlyPointer< Body >:

List of all members.

Public Types
typedef Body	BodyType
Public Member Functions
	RWTOnlyPointer (RWStaticCtor)
	RWTOnlyPointer (Body *bodyP=rwnil)
	RWTOnlyPointer (const RWTOnlyPointer< Body > &second)
	~RWTOnlyPointer (void)
RWTOnlyPointer< Body > &	operator= (const RWTOnlyPointer< Body > &second)
RWTOnlyPointer< Body > &	operator= (Body *ptr)
Body *	operator-> (void) const
Body &	operator* (void) const
	operator Body * (void)
Protected Member Functions
Body *	orphan (void)
void	transfer (Body *bodyP=rwnil)

Detailed Description

template<class Body>
class RWTOnlyPointer< Body >

RWTOnlyPointer<Body> is an abstraction that simplifies the use of pointers referring to objects (that is, bodies) on the heap. It doesn't do reference counting on the body; rather, it is based on the idea of strict ownership semantics. Strict ownership means that if the assignment operator or the copy constructor is called, then the right-hand instance is invalidated (its body pointer is set to rwnil), and the left-hand instance assumes responsibility for deleting the body.

This class is useful for ensuring the recovery of dynamically allocated memory, especially in the presence of exceptions. This class provides functionality equivalent to that provided by the C++ Standard Library class std::auto_ptr.

Examples

 #include <rw/pointer/RWTOnlyPointer.h>

 class A { };

 class B {
 public:
     // The instance of A allocated here is automatically
     // deleted if an exception occurs in the initialize()
     // function.
     B()
     {
       p_ = new A;
       initialize();
     }

 private:
     RWTOnlyPointer<A> p_;
     void initialize(void);
 };

Member Typedef Documentation

template<class Body>

typedef Body RWTOnlyPointer< Body >::BodyType

The type of the body.

Reimplemented from RWTPointer< Body >.

Constructor & Destructor Documentation

template<class Body >

RWTOnlyPointer< Body >::RWTOnlyPointer ( RWStaticCtor ) [inline]

Special constructor that performs no initialization. Throws no exceptions.

template<class Body>

RWTOnlyPointer< Body >::RWTOnlyPointer ( Body * bodyP = rwnil ) [inline]

Assumes responsibility for a new body. This pointer manages an instance parameter bodyP. Throws no exceptions.

template<class Body>

RWTOnlyPointer< Body >::RWTOnlyPointer ( const RWTOnlyPointer< Body > & second ) [inline]

Assumes responsibility for another handle's body.

template<class Body >

RWTOnlyPointer< Body >::~RWTOnlyPointer ( void ) [inline]

Deletes the current body.

Member Function Documentation

template<class Body >

RWTOnlyPointer< Body >::operator Body * ( void ) [inline]

Body pointer conversion operator for the handle (required for handle conversions). Gives up responsibility for deleting the body.

template<class Body >

Body & RWTOnlyPointer< Body >::operator* ( void ) const [inline]

Pointer dereference operator. Dereferences the handle to get a reference to the body. Throws the exception RWTHRInvalidPointer if the pointer is not valid.

template<class Body >

Body * RWTOnlyPointer< Body >::operator-> ( void ) const [inline]

Pointer dereference operator. This operator should always be used to dereference the handle as it first validates the pointer. If the pointer is not valid, throws an RWTHRInvalidPointer exception.

template<class Body>

RWTOnlyPointer< Body > & RWTOnlyPointer< Body >::operator= ( Body * ptr ) [inline]

Assigns a new pointer value to the handle (required for handle conversions). Throws no exceptions.

Reimplemented from RWTPointer< Body >.

template<class Body>

RWTOnlyPointer< Body > & RWTOnlyPointer< Body >::operator= ( const RWTOnlyPointer< Body > & second ) [inline]

Assumes responsibility for another handle's body.

template<class Body >

Body * RWTOnlyPointer< Body >::orphan ( void ) [inline, protected]

Relinquishes control over the current body (if any).

template<class Body>

void RWTOnlyPointer< Body >::transfer ( Body * bodyP = rwnil ) [inline, protected]

Deletes the current body (if any), and assumes control of another body (if any).

SourcePro® C++ API Reference Guide

RWTOnlyPointer< Body > Class Template Reference [Smart Pointers]

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<class Body> class RWTOnlyPointer< Body >

Examples

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

RWTOnlyPointer< Body > Class Template Reference
[Smart Pointers]

template<class Body>
class RWTOnlyPointer< Body >