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. More...

Public Member Functions
	ReferenceCountedObjectPtr () noexcept
	Creates a pointer to a null object. More...
	ReferenceCountedObjectPtr (decltype(nullptr)) noexcept
	Creates a pointer to a null object. More...
	ReferenceCountedObjectPtr (ReferencedType *refCountedObject) noexcept
	Creates a pointer to an object. More...
	ReferenceCountedObjectPtr (ReferencedType &refCountedObject) noexcept
	Creates a pointer to an object. More...
	ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr &other) noexcept
	Copies another pointer. More...
	ReferenceCountedObjectPtr (ReferenceCountedObjectPtr &&other) noexcept
	Takes-over the object from another pointer. More...
template<typename Convertible >
	ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr< Convertible > &other) noexcept
	Copies another pointer. More...
	~ReferenceCountedObjectPtr ()
	Destructor. More...
ReferencedType *	get () const noexcept
	Returns the object that this pointer references. More...
	operator ReferencedType * () const noexcept
	Returns the object that this pointer references. More...
bool	operator!= (decltype(nullptr)) const noexcept
	Checks whether this pointer is null. More...
bool	operator!= (const ObjectType *other) const noexcept
	Compares two ReferenceCountedObjectPtrs. More...
bool	operator!= (const ReferenceCountedObjectPtr &other) const noexcept
	Compares two ReferenceCountedObjectPtrs. More...
ReferencedType &	operator* () const noexcept
	Dereferences the object that this pointer references. More...
ReferencedType *	operator-> () const noexcept
ReferenceCountedObjectPtr &	operator= (const ReferenceCountedObjectPtr &other)
	Changes this pointer to point at a different object. More...
template<typename Convertible >
ReferenceCountedObjectPtr &	operator= (const ReferenceCountedObjectPtr< Convertible > &other)
	Changes this pointer to point at a different object. More...
ReferenceCountedObjectPtr &	operator= (ReferencedType *newObject)
	Changes this pointer to point at a different object. More...
ReferenceCountedObjectPtr &	operator= (ReferencedType &newObject)
	Changes this pointer to point at a different object. More...
ReferenceCountedObjectPtr &	operator= (decltype(nullptr))
	Resets this pointer to a null pointer. More...
ReferenceCountedObjectPtr &	operator= (ReferenceCountedObjectPtr &&other) noexcept
	Takes-over the object from another pointer. More...
bool	operator== (decltype(nullptr)) const noexcept
	Checks whether this pointer is null. More...
bool	operator== (const ObjectType *other) const noexcept
	Compares two ReferenceCountedObjectPtrs. More...
bool	operator== (const ReferenceCountedObjectPtr &other) const noexcept
	Compares two ReferenceCountedObjectPtrs. More...
void	reset () noexcept
	Resets this object to a null pointer. More...

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

Static Public Attributes
static JUCE_DEPRECATED_WITH_BODY(ReferencedType *getObject() const, { return get();}) private voi	incIfNotNull )(ReferencedType *o) noexcept

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

{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 ( )

inlinenoexcept

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.

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.

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).

~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.

Member Function Documentation

decIfNotNull()

template<class ObjectType>

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

inlinestaticnoexcept

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.

Referenced by juce::ReferenceCountedArray< Block >::add(), juce::ReferenceCountedArray< Block >::addIfNotAlreadyThere(), juce::WeakReference< juce::Component >::get(), juce::ReferenceCountedArray< Block >::insert(), juce::nsDictionaryToVar(), juce::ReferenceCountedObjectPtr< juce::ReferenceCountedObject >::operator=(), juce::ReferenceCountedArray< Block >::removeObject(), and juce::WeakReference< juce::Component >::wasObjectDeleted().

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.

operator!=() [1/3]

template<class ObjectType>

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

inlinenoexcept

Checks whether this pointer is null.

operator!=() [2/3]

template<class ObjectType>

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

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

operator!=() [3/3]

template<class ObjectType>

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

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

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.

operator->()

template<class ObjectType>

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

inlinenoexcept

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.

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.

operator=() [3/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.

operator=() [4/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.

operator=() [5/6]

template<class ObjectType>

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

inline

Resets this pointer to a null pointer.

operator=() [6/6]

template<class ObjectType>

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

inlinenoexcept

Takes-over the object from another pointer.

operator==() [1/3]

template<class ObjectType>

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

inlinenoexcept

Checks whether this pointer is null.

operator==() [2/3]

template<class ObjectType>

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

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

operator==() [3/3]

template<class ObjectType>

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

inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

reset()

template<class ObjectType>

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

inlinenoexcept

Resets this object to a null pointer.

Member Data Documentation

incIfNotNull

template<class ObjectType>

JUCE_DEPRECATED_WITH_BODY (ReferencedType* getObject() const, { return get(); }) private voi juce::ReferenceCountedObjectPtr< ObjectType >::incIfNotNull) (ReferencedType *o) noexcept

inlinestaticnoexcept

---

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

• juce_ReferenceCountedObject.h