openshot-audio  0.1.5
Public Types | Public Member Functions | List of all members
juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass > Class Template Reference

#include <juce_core.h>

Public Types

typedef ReferenceCountedObjectClass ReferencedType
 

Public Member Functions

 ReferenceCountedObjectPtr () noexcept
 
 ReferenceCountedObjectPtr (ReferencedType *refCountedObject) noexcept
 
 ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr &other) noexcept
 
template<class Convertible >
 ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr< Convertible > &other) noexcept
 
ReferenceCountedObjectPtroperator= (const ReferenceCountedObjectPtr &other)
 
template<class Convertible >
ReferenceCountedObjectPtroperator= (const ReferenceCountedObjectPtr< Convertible > &other)
 
ReferenceCountedObjectPtroperator= (ReferencedType *const newObject)
 
 ~ReferenceCountedObjectPtr ()
 
 operator ReferencedType * () const noexcept
 
ReferencedTypeget () const noexcept
 
ReferencedTypegetObject () const noexcept
 
ReferencedTypeoperator-> () const noexcept
 

Detailed Description

template<class ReferenceCountedObjectClass>
class juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >

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
{
...
See also
ReferenceCountedObject, ReferenceCountedObjectArray

Member Typedef Documentation

◆ ReferencedType

template<class ReferenceCountedObjectClass>
typedef ReferenceCountedObjectClass juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::ReferencedType

The class being referenced by this pointer.

Constructor & Destructor Documentation

◆ ReferenceCountedObjectPtr() [1/4]

template<class ReferenceCountedObjectClass>
juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::ReferenceCountedObjectPtr ( )
inlinenoexcept

Creates a pointer to a null object.

◆ ReferenceCountedObjectPtr() [2/4]

template<class ReferenceCountedObjectClass>
juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::ReferenceCountedObjectPtr ( ReferencedType refCountedObject)
inlinenoexcept

Creates a pointer to an object. This will increment the object's reference-count.

◆ ReferenceCountedObjectPtr() [3/4]

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

Copies another pointer. This will increment the object's reference-count.

◆ ReferenceCountedObjectPtr() [4/4]

template<class ReferenceCountedObjectClass>
template<class Convertible >
juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::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 ReferenceCountedObjectClass>
juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::~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

◆ get()

template<class ReferenceCountedObjectClass>
ReferencedType* juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::get ( ) const
inlinenoexcept

Returns the object that this pointer references. The pointer returned may be null, of course.

◆ getObject()

template<class ReferenceCountedObjectClass>
ReferencedType* juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::getObject ( ) const
inlinenoexcept

Returns the object that this pointer references. The pointer returned may be null, of course.

◆ operator ReferencedType *()

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

Returns the object that this pointer references. The pointer returned may be null, of course.

◆ operator->()

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

◆ operator=() [1/3]

template<class ReferenceCountedObjectClass>
ReferenceCountedObjectPtr& juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::operator= ( const ReferenceCountedObjectPtr< ReferenceCountedObjectClass > &  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/3]

template<class ReferenceCountedObjectClass>
template<class Convertible >
ReferenceCountedObjectPtr& juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::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/3]

template<class ReferenceCountedObjectClass>
ReferenceCountedObjectPtr& juce::ReferenceCountedObjectPtr< ReferenceCountedObjectClass >::operator= ( ReferencedType *const  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.


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