Poco::AutoPtr< C > Class Template Reference
#include <AutoPtr.h>
Detailed Description
template<class C>
class Poco::AutoPtr< C >
AutoPtr is a "smart" pointer for classes implementing reference counting based garbage collection. To be usable with the AutoPtr template, a class must implement the following behaviour: A class must maintain a reference count. The constructors of the object initialize the reference count to one. The class must implement a public duplicate() method: void duplicate(); that increments the reference count by one. The class must implement a public release() method: void release() that decrements the reference count by one, and, if the reference count reaches zero, deletes the object.
AutoPtr works in the following way: If an AutoPtr is assigned an ordinary pointer to an object (via the constructor or the assignment operator), it takes ownership of the object and the object's reference count remains unchanged. If the AutoPtr is assigned another AutoPtr, the object's reference count is incremented by one by calling duplicate() on its object. The destructor of AutoPtr calls release() on its object. AutoPtr supports dereferencing with both the -> and the * operator. An attempt to dereference a null AutoPtr results in a NullPointerException being thrown. AutoPtr also implements all relational operators. Note that AutoPtr allows casting of its encapsulated data types.
Definition at line 88 of file AutoPtr.h.
Public Member Functions | |
| AutoPtr () | |
| AutoPtr (C *ptr) | |
| AutoPtr (C *ptr, bool shared) | |
| AutoPtr (const AutoPtr &ptr) | |
| template<class Other> | |
| AutoPtr (const AutoPtr< Other > &ptr) | |
| ~AutoPtr () | |
| AutoPtr & | assign (C *ptr) |
| AutoPtr & | assign (C *ptr, bool shared) |
| AutoPtr & | assign (const AutoPtr &ptr) |
| template<class Other> | |
| AutoPtr & | assign (const AutoPtr< Other > &ptr) |
| AutoPtr & | operator= (C *ptr) |
| AutoPtr & | operator= (const AutoPtr &ptr) |
| template<class Other> | |
| AutoPtr & | operator= (const AutoPtr< Other > &ptr) |
| void | swap (AutoPtr &ptr) |
| template<class Other> | |
| AutoPtr< Other > | cast () const |
| Casts the AutoPtr via a dynamic cast to the given type. Returns an AutoPtr containing NULL if the cast fails. Example: (assume class Sub: public Super) AutoPtr<Super> super(new Sub()); AutoPtr<Sub> sub = super.cast<Sub>(); poco_assert (sub.get());. | |
| template<class Other> | |
| AutoPtr< Other > | unsafeCast () const |
| Casts the AutoPtr via a static cast to the given type. Example: (assume class Sub: public Super) AutoPtr<Super> super(new Sub()); AutoPtr<Sub> sub = super.unsafeCast<Sub>(); poco_assert (sub.get());. | |
| C * | operator-> () |
| const C * | operator-> () const |
| C & | operator* () |
| const C & | operator* () const |
| C * | get () |
| const C * | get () const |
| operator C * () | |
| operator const C * () const | |
| bool | operator! () const |
| bool | isNull () const |
| C * | duplicate () |
| bool | operator== (const AutoPtr &ptr) const |
| bool | operator== (const C *ptr) const |
| bool | operator== (C *ptr) const |
| bool | operator!= (const AutoPtr &ptr) const |
| bool | operator!= (const C *ptr) const |
| bool | operator!= (C *ptr) const |
| bool | operator< (const AutoPtr &ptr) const |
| bool | operator< (const C *ptr) const |
| bool | operator< (C *ptr) const |
| bool | operator<= (const AutoPtr &ptr) const |
| bool | operator<= (const C *ptr) const |
| bool | operator<= (C *ptr) const |
| bool | operator> (const AutoPtr &ptr) const |
| bool | operator> (const C *ptr) const |
| bool | operator> (C *ptr) const |
| bool | operator>= (const AutoPtr &ptr) const |
| bool | operator>= (const C *ptr) const |
| bool | operator>= (C *ptr) const |
Private Attributes | |
| C * | _ptr |
Constructor & Destructor Documentation
| Poco::AutoPtr< C >::AutoPtr | ( | ) | [inline] |
| Poco::AutoPtr< C >::AutoPtr | ( | C * | ptr | ) | [inline] |
| Poco::AutoPtr< C >::AutoPtr | ( | C * | ptr, | |
| bool | shared | |||
| ) | [inline] |
| Poco::AutoPtr< C >::AutoPtr | ( | const AutoPtr< C > & | ptr | ) | [inline] |
| Poco::AutoPtr< C >::AutoPtr | ( | const AutoPtr< Other > & | ptr | ) | [inline] |
| Poco::AutoPtr< C >::~AutoPtr | ( | ) | [inline] |
Member Function Documentation
| AutoPtr& Poco::AutoPtr< C >::assign | ( | C * | ptr | ) | [inline] |
Definition at line 151 of file AutoPtr.h.
Referenced by Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator=().
| AutoPtr& Poco::AutoPtr< C >::assign | ( | C * | ptr, | |
| bool | shared | |||
| ) | [inline] |
| AutoPtr& Poco::AutoPtr< C >::assign | ( | const AutoPtr< C > & | ptr | ) | [inline] |
| AutoPtr& Poco::AutoPtr< C >::assign | ( | const AutoPtr< Other > & | ptr | ) | [inline] |
| AutoPtr& Poco::AutoPtr< C >::operator= | ( | C * | ptr | ) | [inline] |
| AutoPtr& Poco::AutoPtr< C >::operator= | ( | const AutoPtr< C > & | ptr | ) | [inline] |
| AutoPtr& Poco::AutoPtr< C >::operator= | ( | const AutoPtr< Other > & | ptr | ) | [inline] |
| void Poco::AutoPtr< C >::swap | ( | AutoPtr< C > & | ptr | ) | [inline] |
| AutoPtr<Other> Poco::AutoPtr< C >::unsafeCast | ( | ) | const [inline] |
| C* Poco::AutoPtr< C >::operator-> | ( | ) | [inline] |
| const C* Poco::AutoPtr< C >::operator-> | ( | ) | const [inline] |
| C& Poco::AutoPtr< C >::operator* | ( | ) | [inline] |
| const C& Poco::AutoPtr< C >::operator* | ( | ) | const [inline] |
| C* Poco::AutoPtr< C >::get | ( | ) | [inline] |
Definition at line 273 of file AutoPtr.h.
Referenced by Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::assign().
| const C* Poco::AutoPtr< C >::get | ( | ) | const [inline] |
| Poco::AutoPtr< C >::operator C * | ( | ) | [inline] |
| Poco::AutoPtr< C >::operator const C * | ( | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator! | ( | ) | const [inline] |
| bool Poco::AutoPtr< C >::isNull | ( | ) | const [inline] |
| C* Poco::AutoPtr< C >::duplicate | ( | ) | [inline] |
| bool Poco::AutoPtr< C >::operator== | ( | const AutoPtr< C > & | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator== | ( | const C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator== | ( | C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator!= | ( | const AutoPtr< C > & | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator!= | ( | const C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator!= | ( | C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator< | ( | const AutoPtr< C > & | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator< | ( | const C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator< | ( | C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator<= | ( | const AutoPtr< C > & | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator<= | ( | const C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator<= | ( | C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator> | ( | const AutoPtr< C > & | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator> | ( | const C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator> | ( | C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator>= | ( | const AutoPtr< C > & | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator>= | ( | const C * | ptr | ) | const [inline] |
| bool Poco::AutoPtr< C >::operator>= | ( | C * | ptr | ) | const [inline] |
Field Documentation
C* Poco::AutoPtr< C >::_ptr [private] |
Definition at line 400 of file AutoPtr.h.
Referenced by Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::assign(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::AutoPtr(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::cast(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::duplicate(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::get(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::isNull(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator const Poco::ThreadImpl::ThreadData *(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator Poco::ThreadImpl::ThreadData *(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator!(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator!=(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator*(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator->(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator<(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator<=(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator==(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator>(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::operator>=(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::swap(), Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::unsafeCast(), and Poco::AutoPtr< Poco::ThreadImpl::ThreadData >::~AutoPtr().
The documentation for this class was generated from the following file:
- C:/es40/src/vms/AutoPtr.h