A smart-pointer class which points to a reference-counted object. More...

#include "juce_ReferenceCountedObject.h"

Public Types
using	ReferencedType = ObjectType
	The class being referenced by this pointer.

Public Member Functions
	ReferenceCountedObjectPtr ()=default
	Creates a pointer to a null object.

	ReferenceCountedObjectPtr (decltype(nullptr)) noexcept
	Creates a pointer to a null object.

	ReferenceCountedObjectPtr (ReferencedType *refCountedObject) noexcept
	Creates a pointer to an object.

	ReferenceCountedObjectPtr (ReferencedType &refCountedObject) noexcept
	Creates a pointer to an object.

	ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr &other) noexcept
	Copies another pointer.

	ReferenceCountedObjectPtr (ReferenceCountedObjectPtr &&other) noexcept
	Takes-over the object from another pointer.

template<typename Convertible >
	ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr< Convertible > &other) noexcept
	Copies another pointer.

ReferenceCountedObjectPtr &	operator= (const ReferenceCountedObjectPtr &other)
	Changes this pointer to point at a different object.

template<typename Convertible >
ReferenceCountedObjectPtr &	operator= (const ReferenceCountedObjectPtr< Convertible > &other)
	Changes this pointer to point at a different object.

ReferenceCountedObjectPtr &	operator= (ReferencedType *newObject)
	Changes this pointer to point at a different object.

ReferenceCountedObjectPtr &	operator= (ReferencedType &newObject)
	Changes this pointer to point at a different object.

ReferenceCountedObjectPtr &	operator= (decltype(nullptr))
	Resets this pointer to a null pointer.

ReferenceCountedObjectPtr &	operator= (ReferenceCountedObjectPtr &&other) noexcept
	Takes-over the object from another pointer.

	~ReferenceCountedObjectPtr ()
	Destructor.

ReferencedType *	get () const noexcept
	Returns the object that this pointer references.

void	reset () noexcept
	Resets this object to a null pointer.

ReferencedType *	operator-> () const noexcept

ReferencedType &	operator* () const noexcept
	Dereferences the object that this pointer references.

bool	operator== (decltype(nullptr)) const noexcept
	Checks whether this pointer is null.

bool	operator!= (decltype(nullptr)) const noexcept
	Checks whether this pointer is null.

bool	operator== (const ObjectType *other) const noexcept
	Compares two ReferenceCountedObjectPtrs.

bool	operator== (const ReferenceCountedObjectPtr &other) const noexcept
	Compares two ReferenceCountedObjectPtrs.

bool	operator!= (const ObjectType *other) const noexcept
	Compares two ReferenceCountedObjectPtrs.

bool	operator!= (const ReferenceCountedObjectPtr &other) const noexcept
	Compares two ReferenceCountedObjectPtrs.

	operator ReferencedType * () const noexcept
	Returns the object that this pointer references.

Detailed Description

template<class ObjectType>
class juce::ReferenceCountedObjectPtr< ObjectType >

A smart-pointer class which points to a reference-counted object.

The template parameter specifies the class of the object you want to point to - the easiest way to make a class reference-countable is to simply make it inherit from ReferenceCountedObject or SingleThreadedReferenceCountedObject, but if you need to, you can roll your own reference-countable class by implementing a set of methods called incReferenceCount(), decReferenceCount(), and decReferenceCountWithoutDeleting(). See ReferenceCountedObject for examples of how these methods should behave.

When using this class, you'll probably want to create a typedef to abbreviate the full templated name - e.g.

struct MyClass  : public ReferenceCountedObject
{
    using Ptr = ReferenceCountedObjectPtr<MyClass>;
    ...
}

See also: ReferenceCountedObject, ReferenceCountedObjectArray

@tags{Core}

Definition at line 246 of file juce_ReferenceCountedObject.h.

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ReferencedType

Constructor & Destructor Documentation

◆ ReferenceCountedObjectPtr() [1/6]

◆ ReferenceCountedObjectPtr() [2/6]

◆ ReferenceCountedObjectPtr() [3/6]

◆ ReferenceCountedObjectPtr() [4/6]

◆ ReferenceCountedObjectPtr() [5/6]

◆ ReferenceCountedObjectPtr() [6/6]

◆ ~ReferenceCountedObjectPtr()

Member Function Documentation

◆ get()

◆ operator ReferencedType *()

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator*()

◆ operator->()

◆ operator=() [1/6]

◆ operator=() [2/6]

◆ operator=() [3/6]

◆ operator=() [4/6]

◆ operator=() [5/6]

◆ operator=() [6/6]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ reset()