regina::StoreManagedPtr< T > Class Template Reference
[General Utility Classes]

An NProperty storage policy indicating that the property should be held by pointer and that the property wrapper will also take responsibility for memory management. More...

#include <nproperty.h>

List of all members.

Public Types
typedef T *	InitType
	The type by which new values for the underlying property are passed.
typedef const T *	QueryType
	The type by which the property value is returned to the user.
Public Member Functions
	StoreManagedPtr ()
	Constructor that sets the held pointer to 0.
void	clear ()
	Cleans up any currently held value before the property value is changed or cleared.
Protected Member Functions
	~StoreManagedPtr ()
	Destroys the currently held value if one exists.
Protected Attributes
T *	value_
	The held property value.

---

Detailed Description

template<typename T>
class regina::StoreManagedPtr< T >

An NProperty storage policy indicating that the property should be held by pointer and that the property wrapper will also take responsibility for memory management.

The property assignment and query routines will also use pointers; in particular the query routines will return a constant pointer. When the held value is changed or the NProperty wrapper is destroyed, any currently held value will be destroyed automatically.

See the NProperty class notes for details.

Python:

Not present.

---

Member Typedef Documentation

template<typename T>

typedef T* regina::StoreManagedPtr< T >::InitType

The type by which new values for the underlying property are passed.

Reimplemented in regina::NProperty< regina::NAbelianGroup, regina::StoreManagedPtr< T > >, and regina::NProperty< regina::NGroupPresentation, regina::StoreManagedPtr< T > >.

template<typename T>

typedef const T* regina::StoreManagedPtr< T >::QueryType

The type by which the property value is returned to the user.

Reimplemented in regina::NProperty< regina::NAbelianGroup, regina::StoreManagedPtr< T > >, and regina::NProperty< regina::NGroupPresentation, regina::StoreManagedPtr< T > >.

---

Constructor & Destructor Documentation

template<typename T>

regina::StoreManagedPtr< T >::StoreManagedPtr

(

)

[inline]

Constructor that sets the held pointer to 0.

template<typename T>

regina::StoreManagedPtr< T >::~StoreManagedPtr

(

)

[inline, protected]

Destroys the currently held value if one exists.

---

Member Function Documentation

template<typename T>

void regina::StoreManagedPtr< T >::clear

(

)

[inline]

Cleans up any currently held value before the property value is changed or cleared.

This implementation resets the held pointer to 0 and destroys the previously held value if any exists.

Reimplemented in regina::NProperty< regina::NAbelianGroup, regina::StoreManagedPtr< T > >, and regina::NProperty< regina::NGroupPresentation, regina::StoreManagedPtr< T > >.

---

Member Data Documentation

template<typename T>

T* regina::StoreManagedPtr< T >::value_ [protected]

The held property value.

---

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

• nproperty.h