Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: nRF51_Vdd TextLCD BME280
SharedPtr< T > Class Template Reference
Shared pointer class. More...
#include <SharedPtr.h>
Public Member Functions | |
SharedPtr () | |
Create empty SharedPtr not pointing to anything. | |
SharedPtr (T *ptr) | |
Create new SharedPtr. | |
~SharedPtr () | |
Destructor. | |
SharedPtr (const SharedPtr &source) | |
Copy constructor. | |
SharedPtr | operator= (const SharedPtr &source) |
Assignment operator. | |
void | reset (T *ptr) |
Replaces the managed pointer with a new unmanaged pointer. | |
void | reset () |
Replace the managed pointer with a NULL pointer. | |
T * | get () const |
Raw pointer accessor. | |
uint32_t | use_count () const |
Reference count accessor. | |
T & | operator* () const |
Dereference object operator. | |
T * | operator-> () const |
Dereference object member operator. | |
operator bool () const | |
Boolean conversion operator. |
Detailed Description
template<class T>
class SharedPtr< T >
Shared pointer class.
A shared pointer is a "smart" pointer that retains ownership of an object using reference counting accross all smart pointers referencing that object.
#include "platform/SharedPtr.h" void test() { struct MyStruct { int a; }; // Create shared pointer SharedPtr<MyStruct> ptr( new MyStruct ); // Increase reference count SharedPtr<MyStruct> ptr2( ptr ); ptr = NULL; // Reference to the struct instance is still held by ptr2 ptr2 = NULL; // The raw pointer is freed }
It is similar to the std::shared_ptr class introduced in C++11; however, this is not a compatible implementation (no weak pointer, no make_shared, no custom deleters and so on.)
Usage: SharedPtr<Class> ptr(new Class())
When ptr is passed around by value, the copy constructor and destructor manages the reference count of the raw pointer. If the counter reaches zero, delete is called on the raw pointer.
To avoid loops, use "weak" references by calling the original pointer directly through ptr.get().
Definition at line 65 of file SharedPtr.h.
Constructor & Destructor Documentation
SharedPtr | ( | ) |
Create empty SharedPtr not pointing to anything.
Used for variable declaration.
Definition at line 71 of file SharedPtr.h.
SharedPtr | ( | T * | ptr ) |
Create new SharedPtr.
- Parameters:
-
ptr Pointer to take control over
Definition at line 79 of file SharedPtr.h.
~SharedPtr | ( | ) |
Destructor.
Decrement reference counter, and delete object if no longer pointed to.
Definition at line 92 of file SharedPtr.h.
Copy constructor.
Create new SharedPtr from other SharedPtr by copying pointer to original object and pointer to counter.
- Parameters:
-
source Object being copied from.
Definition at line 103 of file SharedPtr.h.
Member Function Documentation
T* get | ( | ) | const |
Raw pointer accessor.
Get raw pointer to object pointed to.
- Returns:
- Pointer.
Definition at line 165 of file SharedPtr.h.
operator bool | ( | ) | const |
Boolean conversion operator.
- Returns:
- Whether or not the pointer is NULL.
Definition at line 208 of file SharedPtr.h.
T& operator* | ( | ) | const |
Dereference object operator.
Override to return the object pointed to.
Definition at line 190 of file SharedPtr.h.
T* operator-> | ( | ) | const |
Dereference object member operator.
Override to return return member in object pointed to.
Definition at line 199 of file SharedPtr.h.
Assignment operator.
Cleanup previous reference and assign new pointer and counter.
- Parameters:
-
source Object being assigned from.
- Returns:
- Object being assigned.
Definition at line 117 of file SharedPtr.h.
void reset | ( | T * | ptr ) |
Replaces the managed pointer with a new unmanaged pointer.
- Parameters:
-
[in] ptr the new raw pointer to manage.
Definition at line 140 of file SharedPtr.h.
void reset | ( | void | ) |
Replace the managed pointer with a NULL pointer.
Definition at line 155 of file SharedPtr.h.
uint32_t use_count | ( | ) | const |
Generated on Tue Jul 12 2022 15:16:17 by
