juce::ReferenceCountedObjectPtr< ObjectType > Class Template Reference

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

#include <juce_ReferenceCountedObject.h>

Inheritance diagram for juce::ReferenceCountedObjectPtr< ObjectType >:

Collaboration diagram for juce::ReferenceCountedObjectPtr< ObjectType >:

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 (const ReferenceCountedObjectPtr &other) noexcept
	Copies another pointer.
template<typename Convertible >
	ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr< Convertible > &other) noexcept
	Copies another pointer.
	ReferenceCountedObjectPtr (decltype(nullptr)) noexcept
	Creates a pointer to a null object.
	ReferenceCountedObjectPtr (ReferenceCountedObjectPtr &&other) noexcept
	Takes-over the object from another pointer.
	ReferenceCountedObjectPtr (ReferencedType &refCountedObject) noexcept
	Creates a pointer to an object.
	ReferenceCountedObjectPtr (ReferencedType *refCountedObject) noexcept
	Creates a pointer to an object.
	~ReferenceCountedObjectPtr ()
	Destructor.
ReferencedType *	get () const noexcept
	Returns the object that this pointer references.
	operator ReferencedType * () const noexcept
	Returns the object that this pointer references.
bool	operator!= (const ObjectType *other) const noexcept
	Compares two ReferenceCountedObjectPtrs.
bool	operator!= (const ReferenceCountedObjectPtr &other) const noexcept
	Compares two ReferenceCountedObjectPtrs.
bool	operator!= (decltype(nullptr)) const noexcept
	Checks whether this pointer is null.
ReferencedType &	operator* () const noexcept
	Dereferences the object that this pointer references.
ReferencedType *	operator-> () const noexcept
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= (decltype(nullptr))
	Resets this pointer to a null pointer.
ReferenceCountedObjectPtr &	operator= (ReferenceCountedObjectPtr &&other) noexcept
	Takes-over the object from another pointer.
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.
bool	operator== (const ObjectType *other) const noexcept
	Compares two ReferenceCountedObjectPtrs.
bool	operator== (const ReferenceCountedObjectPtr &other) const noexcept
	Compares two ReferenceCountedObjectPtrs.
bool	operator== (decltype(nullptr)) const noexcept
	Checks whether this pointer is null.
void	reset () noexcept
	Resets this object to a null pointer.

Static Private Member Functions
static void	decIfNotNull (ReferencedType *o) noexcept
static void	incIfNotNull (ReferencedType *o) noexcept

Private Attributes
ReferencedType *	referencedObject = nullptr

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}

Member Typedef Documentation

ReferencedType

template<class ObjectType >

using juce::ReferenceCountedObjectPtr< ObjectType >::ReferencedType = ObjectType

The class being referenced by this pointer.

Constructor & Destructor Documentation

ReferenceCountedObjectPtr() [1/7]

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( )

default

Creates a pointer to a null object.

ReferenceCountedObjectPtr() [2/7]

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( decltype(nullptr)  )

inlinenoexcept

Creates a pointer to a null object.

ReferenceCountedObjectPtr() [3/7]

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( ReferencedType *  refCountedObject )

inlinenoexcept

Creates a pointer to an object.

This will increment the object's reference-count.

References juce::ReferenceCountedObjectPtr< ObjectType >::incIfNotNull().

ReferenceCountedObjectPtr() [4/7]

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( ReferencedType &  refCountedObject )

inlinenoexcept

Creates a pointer to an object.

This will increment the object's reference-count.

ReferenceCountedObjectPtr() [5/7]

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( const ReferenceCountedObjectPtr< ObjectType > &  other )

inlinenoexcept

Copies another pointer.

This will increment the object's reference-count.

References juce::ReferenceCountedObjectPtr< ObjectType >::incIfNotNull(), and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

ReferenceCountedObjectPtr() [6/7]

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( ReferenceCountedObjectPtr< ObjectType > &&  other )

inlinenoexcept

Takes-over the object from another pointer.

ReferenceCountedObjectPtr() [7/7]

template<class ObjectType >

template<typename Convertible >

juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( const ReferenceCountedObjectPtr< Convertible > &  other )

inlinenoexcept

Copies another pointer.

This will increment the object's reference-count (if it is non-null).

References juce::ReferenceCountedObjectPtr< ObjectType >::incIfNotNull(), and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

~ReferenceCountedObjectPtr()

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::~ReferenceCountedObjectPtr ( )

inline

Destructor.

This will decrement the object's reference-count, which will cause the object to be deleted when the ref-count hits zero.

References juce::ReferenceCountedObjectPtr< ObjectType >::decIfNotNull(), and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

Member Function Documentation

decIfNotNull()

template<class ObjectType >

static void juce::ReferenceCountedObjectPtr< ObjectType >::decIfNotNull ( ReferencedType *  o )

inlinestaticprivatenoexcept

References juce::ContainerDeletePolicy< ObjectType >::destroy().

Referenced by juce::ReferenceCountedObjectPtr< ObjectType >::~ReferenceCountedObjectPtr(), juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), and juce::ReferenceCountedObjectPtr< ObjectType >::reset().

get()

template<class ObjectType >

ReferencedType * juce::ReferenceCountedObjectPtr< ObjectType >::get ( ) const

inlinenoexcept

Returns the object that this pointer references.

The pointer returned may be null, of course.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

Referenced by juce::WeakReference< ObjectType, ReferenceCountingType >::Master::~Master(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::add(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere(), juce::WeakReference< ObjectType, ReferenceCountingType >::get(), juce::WeakReference< ObjectType, ReferenceCountingType >::Master::getSharedPointer(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::insert(), juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject(), juce::ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::set(), and juce::WeakReference< ObjectType, ReferenceCountingType >::wasObjectDeleted().

incIfNotNull()

template<class ObjectType >

static void juce::ReferenceCountedObjectPtr< ObjectType >::incIfNotNull ( ReferencedType *  o )

inlinestaticprivatenoexcept

Referenced by juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr(), juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr(), and juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr().

operator ReferencedType *()

template<class ObjectType >

juce::ReferenceCountedObjectPtr< ObjectType >::operator ReferencedType * ( ) const

inlinenoexcept

Returns the object that this pointer references.

The pointer returned may be null, of course. Note that this methods allows the compiler to be very lenient with what it allows you to do with the pointer, it's safer to disable this by setting JUCE_STRICT_REFCOUNTEDPOINTER=1, which increased type safety and can prevent some common slip-ups.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator!=() [1/3]

template<class ObjectType >

bool juce::ReferenceCountedObjectPtr< ObjectType >::operator!= ( const ObjectType *  other ) const

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator!=() [2/3]

template<class ObjectType >

bool juce::ReferenceCountedObjectPtr< ObjectType >::operator!= ( const ReferenceCountedObjectPtr< ObjectType > &  other ) const

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator!=() [3/3]

template<class ObjectType >

bool juce::ReferenceCountedObjectPtr< ObjectType >::operator!= ( decltype(nullptr)  ) const

inlinenoexcept

Checks whether this pointer is null.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator*()

template<class ObjectType >

ReferencedType & juce::ReferenceCountedObjectPtr< ObjectType >::operator* ( ) const

inlinenoexcept

Dereferences the object that this pointer references.

The pointer returned may be null, of course.

References jassert, and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator->()

template<class ObjectType >

ReferencedType * juce::ReferenceCountedObjectPtr< ObjectType >::operator-> ( ) const

inlinenoexcept

References jassert, and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator=() [1/6]

template<class ObjectType >

ReferenceCountedObjectPtr & juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( const ReferenceCountedObjectPtr< ObjectType > &  other )

inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

References juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

Referenced by juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), and juce::ReferenceCountedObjectPtr< ObjectType >::operator=().

operator=() [2/6]

template<class ObjectType >

template<typename Convertible >

ReferenceCountedObjectPtr & juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( const ReferenceCountedObjectPtr< Convertible > &  other )

inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

References juce::ReferenceCountedObjectPtr< ObjectType >::get(), and juce::ReferenceCountedObjectPtr< ObjectType >::operator=().

operator=() [3/6]

template<class ObjectType >

ReferenceCountedObjectPtr & juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( decltype(nullptr)  )

inline

Resets this pointer to a null pointer.

References juce::ReferenceCountedObjectPtr< ObjectType >::reset().

operator=() [4/6]

template<class ObjectType >

ReferenceCountedObjectPtr & juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( ReferenceCountedObjectPtr< ObjectType > &&  other )

inlinenoexcept

Takes-over the object from another pointer.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator=() [5/6]

template<class ObjectType >

ReferenceCountedObjectPtr & juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( ReferencedType &  newObject )

inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

References juce::ReferenceCountedObjectPtr< ObjectType >::decIfNotNull(), and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator=() [6/6]

template<class ObjectType >

ReferenceCountedObjectPtr & juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( ReferencedType *  newObject )

inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

References juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), and juce::ReferenceCountedObjectPtr< ObjectType >::reset().

operator==() [1/3]

template<class ObjectType >

bool juce::ReferenceCountedObjectPtr< ObjectType >::operator== ( const ObjectType *  other ) const

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator==() [2/3]

template<class ObjectType >

bool juce::ReferenceCountedObjectPtr< ObjectType >::operator== ( const ReferenceCountedObjectPtr< ObjectType > &  other ) const

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

operator==() [3/3]

template<class ObjectType >

bool juce::ReferenceCountedObjectPtr< ObjectType >::operator== ( decltype(nullptr)  ) const

inlinenoexcept

Checks whether this pointer is null.

References juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

reset()

template<class ObjectType >

void juce::ReferenceCountedObjectPtr< ObjectType >::reset ( )

inlinenoexcept

Resets this object to a null pointer.

References juce::ReferenceCountedObjectPtr< ObjectType >::decIfNotNull(), and juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject.

Referenced by juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), and juce::ReferenceCountedObjectPtr< ObjectType >::operator=().

Member Data Documentation

referencedObject

template<class ObjectType >

ReferencedType* juce::ReferenceCountedObjectPtr< ObjectType >::referencedObject = nullptr

private

Referenced by juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr(), juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr(), juce::ReferenceCountedObjectPtr< ObjectType >::~ReferenceCountedObjectPtr(), juce::ReferenceCountedObjectPtr< ObjectType >::get(), juce::ReferenceCountedObjectPtr< ObjectType >::operator ReferencedType *(), juce::ReferenceCountedObjectPtr< ObjectType >::operator!=(), juce::ReferenceCountedObjectPtr< ObjectType >::operator!=(), juce::ReferenceCountedObjectPtr< ObjectType >::operator!=(), juce::ReferenceCountedObjectPtr< ObjectType >::operator*(), juce::ReferenceCountedObjectPtr< ObjectType >::operator->(), juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), juce::ReferenceCountedObjectPtr< ObjectType >::operator=(), juce::ReferenceCountedObjectPtr< ObjectType >::operator==(), juce::ReferenceCountedObjectPtr< ObjectType >::operator==(), juce::ReferenceCountedObjectPtr< ObjectType >::operator==(), and juce::ReferenceCountedObjectPtr< ObjectType >::reset().

---

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

• juce_ReferenceCountedObject.h