OpenShot Audio Library | OpenShotAudio 0.3.2
Loading...
Searching...
No Matches
juce::ReferenceCountedObjectPtr< ObjectType > Class Template Reference

#include <juce_ReferenceCountedObject.h>

Public Types

using ReferencedType = ObjectType
 

Public Member Functions

 ReferenceCountedObjectPtr ()=default
 
 ReferenceCountedObjectPtr (decltype(nullptr)) noexcept
 
 ReferenceCountedObjectPtr (ReferencedType *refCountedObject) noexcept
 
 ReferenceCountedObjectPtr (ReferencedType &refCountedObject) noexcept
 
 ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr &other) noexcept
 
 ReferenceCountedObjectPtr (ReferenceCountedObjectPtr &&other) noexcept
 
template<typename Convertible >
 ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr< Convertible > &other) noexcept
 
ReferenceCountedObjectPtroperator= (const ReferenceCountedObjectPtr &other)
 
template<typename Convertible >
ReferenceCountedObjectPtroperator= (const ReferenceCountedObjectPtr< Convertible > &other)
 
ReferenceCountedObjectPtroperator= (ReferencedType *newObject)
 
ReferenceCountedObjectPtroperator= (ReferencedType &newObject)
 
ReferenceCountedObjectPtroperator= (decltype(nullptr))
 
ReferenceCountedObjectPtroperator= (ReferenceCountedObjectPtr &&other) noexcept
 
 ~ReferenceCountedObjectPtr ()
 
ReferencedTypeget () const noexcept
 
void reset () noexcept
 
ReferencedTypeoperator-> () const noexcept
 
ReferencedTypeoperator* () const noexcept
 
bool operator== (decltype(nullptr)) const noexcept
 
bool operator!= (decltype(nullptr)) const noexcept
 
bool operator== (const ObjectType *other) const noexcept
 
bool operator== (const ReferenceCountedObjectPtr &other) const noexcept
 
bool operator!= (const ObjectType *other) const noexcept
 
bool operator!= (const ReferenceCountedObjectPtr &other) const noexcept
 
 operator ReferencedType * () const noexcept
 

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.

See also
ReferenceCountedObject, ReferenceCountedObjectArray

Definition at line 246 of file juce_ReferenceCountedObject.h.

Member Typedef Documentation

◆ ReferencedType

The class being referenced by this pointer.

Definition at line 250 of file juce_ReferenceCountedObject.h.

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.

Definition at line 257 of file juce_ReferenceCountedObject.h.

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

Definition at line 262 of file juce_ReferenceCountedObject.h.

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

Definition at line 271 of file juce_ReferenceCountedObject.h.

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

Definition at line 280 of file juce_ReferenceCountedObject.h.

◆ ReferenceCountedObjectPtr() [6/7]

template<class ObjectType >
juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( ReferenceCountedObjectPtr< ObjectType > &&  other)
inlinenoexcept

Takes-over the object from another pointer.

Definition at line 287 of file juce_ReferenceCountedObject.h.

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

Definition at line 297 of file juce_ReferenceCountedObject.h.

◆ ~ReferenceCountedObjectPtr()

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

Definition at line 372 of file juce_ReferenceCountedObject.h.

Member Function Documentation

◆ decIfNotNull()

template<class ObjectType >
static void juce::ReferenceCountedObjectPtr< ObjectType >::decIfNotNull ( ReferencedType o)
inlinestaticnoexcept

Definition at line 445 of file juce_ReferenceCountedObject.h.

◆ get()

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

Definition at line 428 of file juce_ReferenceCountedObject.h.

◆ operator!=() [1/3]

template<class ObjectType >
bool juce::ReferenceCountedObjectPtr< ObjectType >::operator!= ( const ObjectType other) const
inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

Definition at line 413 of file juce_ReferenceCountedObject.h.

◆ operator!=() [2/3]

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

Compares two ReferenceCountedObjectPtrs.

Definition at line 415 of file juce_ReferenceCountedObject.h.

◆ operator!=() [3/3]

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

Checks whether this pointer is null

Definition at line 406 of file juce_ReferenceCountedObject.h.

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

Definition at line 401 of file juce_ReferenceCountedObject.h.

◆ operator->()

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

Definition at line 392 of file juce_ReferenceCountedObject.h.

◆ operator=() [1/6]

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.

Definition at line 307 of file juce_ReferenceCountedObject.h.

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

◆ operator=() [2/6]

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.

Definition at line 317 of file juce_ReferenceCountedObject.h.

◆ operator=() [3/6]

Resets this pointer to a null pointer.

Definition at line 355 of file juce_ReferenceCountedObject.h.

◆ operator=() [4/6]

Takes-over the object from another pointer.

Definition at line 362 of file juce_ReferenceCountedObject.h.

◆ operator=() [5/6]

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.

Definition at line 341 of file juce_ReferenceCountedObject.h.

◆ operator=() [6/6]

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.

Definition at line 327 of file juce_ReferenceCountedObject.h.

◆ operator==() [1/3]

template<class ObjectType >
bool juce::ReferenceCountedObjectPtr< ObjectType >::operator== ( const ObjectType other) const
inlinenoexcept

Compares two ReferenceCountedObjectPtrs.

Definition at line 409 of file juce_ReferenceCountedObject.h.

◆ operator==() [2/3]

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

Compares two ReferenceCountedObjectPtrs.

Definition at line 411 of file juce_ReferenceCountedObject.h.

◆ operator==() [3/3]

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

Checks whether this pointer is null

Definition at line 404 of file juce_ReferenceCountedObject.h.

◆ reset()

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

Definition at line 439 of file juce_ReferenceCountedObject.h.


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