---

proxy_ptr Class Template Reference

This class emulates a pointer in all respects, and is simply an aid to self-documentation. More...

#include <stlsoft_proxy_ptr.h>

List of all members.

Public Types
typedef T	value_type
	The value type.
typedef proxy_ptr< T >	class_type
	The current parameterisation of the type.
Public Methods
	proxy_ptr (value_type *t)
	Construct from a pointer to "borrow".
proxy_ptr &	operator= (value_type *t)
	Assignment from a new pointer.
	operator value_type * ()
	Implicit conversion to pointer to the underlying pointer.
	operator const value_type * () const
	Implicit conversion to pointer-to-const to the underlying pointer.
value_type &	operator * ()
	Indirection operator.
value_type const &	operator * () const
	Indirection operator.
value_type *	operator-> ()
	Member-selection operator.
value_type const *	operator-> () const
	Member-selection operator.
value_type *	get_ptr ()
	Returns the underlying pointer value.
value_type const *	get_ptr () const
	Returns the underlying pointer value.
value_type *	GetPointer ()
	Returns the underlying pointer value.
value_type const *	GetPointer () const
	Returns the underlying pointer value.
void	clear ()
	Sets the underlying pointer value to null.

---

Detailed Description

template<typename T>
class stlsoft::proxy_ptr< T >

This class emulates a pointer in all respects, and is simply an aid to self-documentation.

Parameters:

T	The value type

---

Member Typedef Documentation

typedef proxy_ptr<T> class_type

The current parameterisation of the type.

typedef T value_type

The value type.

---

Constructor & Destructor Documentation

proxy_ptr (  value_type *    t )  [inline, explicit]

Construct from a pointer to "borrow".

---

Member Function Documentation

void clear (    )  [inline]

Sets the underlying pointer value to null.

value_type const* get_ptr (    )  const [inline]

Returns the underlying pointer value.

value_type* get_ptr (    )  [inline]

Returns the underlying pointer value.

value_type const* GetPointer (    )  const [inline]

Returns the underlying pointer value. Deprecated:

value_type* GetPointer (    )  [inline]

Returns the underlying pointer value. Deprecated:

value_type const& operator * (    )  const [inline]

Indirection operator. Note: This method does a debug-time assertion that the underlying pointer is non-null

value_type& operator * (    )  [inline]

Indirection operator. Note: This method does a debug-time assertion that the underlying pointer is non-null

operator const value_type * (    )  const [inline]

Implicit conversion to pointer-to-const to the underlying pointer.

operator value_type * (    )  [inline]

Implicit conversion to pointer to the underlying pointer.

value_type const* operator-> (    )  const [inline]

Member-selection operator. Note: This method does a debug-time assertion that the underlying pointer is non-null

value_type* operator-> (    )  [inline]

Member-selection operator. Note: This method does a debug-time assertion that the underlying pointer is non-null

proxy_ptr& operator= (  value_type *    t )  [inline]

Assignment from a new pointer.

---

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

• stlsoft_proxy_ptr.h

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004