JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins
« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
juce::SingleThreadedReferenceCountedObject Class Reference

Adds reference-counting to an object. More...

#include "juce_ReferenceCountedObject.h"

Inheritance diagram for juce::SingleThreadedReferenceCountedObject:
juce::Expression::Term juce::PopupMenu::CustomCallback juce::PopupMenu::CustomComponent juce::RenderingHelpers::ClipRegions< SavedStateType >::Base juce::Expression::Helpers::BinaryTerm juce::Expression::Helpers::Constant juce::Expression::Helpers::Function juce::Expression::Helpers::Negate juce::Expression::Helpers::SymbolTerm juce::PopupMenu::HelperClasses::HeaderItemComponent juce::PopupMenu::HelperClasses::NormalComponentWrapper juce::Toolbar::MissingItemsComponent juce::RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion juce::RenderingHelpers::ClipRegions< SavedStateType >::RectangleListRegion

Public Member Functions

void incReferenceCount () noexcept
 Increments the object's reference count.
 
void decReferenceCount () noexcept
 Decreases the object's reference count.
 
bool decReferenceCountWithoutDeleting () noexcept
 Decreases the object's reference count.
 
int getReferenceCount () const noexcept
 Returns the object's current reference count.
 

Protected Member Functions

 SingleThreadedReferenceCountedObject ()=default
 Creates the reference-counted object (with an initial ref count of zero).
 
 SingleThreadedReferenceCountedObject (const SingleThreadedReferenceCountedObject &)
 Copying from another object does not affect this one's reference-count.
 
 SingleThreadedReferenceCountedObject (SingleThreadedReferenceCountedObject &&)
 Copying from another object does not affect this one's reference-count.
 
SingleThreadedReferenceCountedObject & operator= (const SingleThreadedReferenceCountedObject &)
 Copying from another object does not affect this one's reference-count.
 
SingleThreadedReferenceCountedObject & operator= (SingleThreadedReferenceCountedObject &&)
 Copying from another object does not affect this one's reference-count.
 
virtual ~SingleThreadedReferenceCountedObject ()
 Destructor.
 

Friends

struct ContainerDeletePolicy< ReferenceCountedObject >
 

Detailed Description

Adds reference-counting to an object.

This is effectively a version of the ReferenceCountedObject class, but which uses a non-atomic counter, and so is not thread-safe (but which will be more efficient). For more details on how to use it, see the ReferenceCountedObject class notes.

See also
ReferenceCountedObject, ReferenceCountedObjectPtr, ReferenceCountedArray

@tags{Core}

Definition at line 153 of file juce_ReferenceCountedObject.h.

Constructor & Destructor Documentation

◆ SingleThreadedReferenceCountedObject() [1/2]

juce::SingleThreadedReferenceCountedObject::SingleThreadedReferenceCountedObject ( const SingleThreadedReferenceCountedObject &  )
protected

Copying from another object does not affect this one's reference-count.

Definition at line 198 of file juce_ReferenceCountedObject.h.

◆ SingleThreadedReferenceCountedObject() [2/2]

juce::SingleThreadedReferenceCountedObject::SingleThreadedReferenceCountedObject ( SingleThreadedReferenceCountedObject &&  )
protected

Copying from another object does not affect this one's reference-count.

Definition at line 200 of file juce_ReferenceCountedObject.h.

◆ ~SingleThreadedReferenceCountedObject()

virtual juce::SingleThreadedReferenceCountedObject::~SingleThreadedReferenceCountedObject ( )
protectedvirtual

Destructor.

Definition at line 207 of file juce_ReferenceCountedObject.h.

Member Function Documentation

◆ decReferenceCount()

void juce::SingleThreadedReferenceCountedObject::decReferenceCount ( )
noexcept

Decreases the object's reference count.

If the count gets to zero, the object will be deleted.

Definition at line 170 of file juce_ReferenceCountedObject.h.

◆ decReferenceCountWithoutDeleting()

bool juce::SingleThreadedReferenceCountedObject::decReferenceCountWithoutDeleting ( )
noexcept

Decreases the object's reference count.

If the count gets to zero, the object will not be deleted, but this method will return true, allowing the caller to take care of deletion.

Definition at line 182 of file juce_ReferenceCountedObject.h.

◆ getReferenceCount()

int juce::SingleThreadedReferenceCountedObject::getReferenceCount ( ) const
noexcept

Returns the object's current reference count.

Definition at line 189 of file juce_ReferenceCountedObject.h.

◆ incReferenceCount()

void juce::SingleThreadedReferenceCountedObject::incReferenceCount ( )
noexcept

Increments the object's reference count.

This is done automatically by the smart pointer, but is public just in case it's needed for nefarious purposes.

Definition at line 162 of file juce_ReferenceCountedObject.h.

◆ operator=() [1/2]

SingleThreadedReferenceCountedObject & juce::SingleThreadedReferenceCountedObject::operator= ( const SingleThreadedReferenceCountedObject &  )
protected

Copying from another object does not affect this one's reference-count.

Definition at line 202 of file juce_ReferenceCountedObject.h.

◆ operator=() [2/2]

SingleThreadedReferenceCountedObject & juce::SingleThreadedReferenceCountedObject::operator= ( SingleThreadedReferenceCountedObject &&  )
protected

Copying from another object does not affect this one's reference-count.

Definition at line 204 of file juce_ReferenceCountedObject.h.

Friends And Related Symbol Documentation

◆ ContainerDeletePolicy< ReferenceCountedObject >

friend struct ContainerDeletePolicy< ReferenceCountedObject >
friend

Definition at line 215 of file juce_ReferenceCountedObject.h.

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