JUCE v8.0.9
JUCE API
 
Loading...
Searching...
No Matches
juce::ARAHostModel::ManagedARAHandle< Base, PtrIn > Class Template Reference

This class is used by the various ARA model object helper classes, such as MusicalContext, AudioSource etc. More...

Inheritance diagram for juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >:
Collaboration diagram for juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >:

Classes

struct  Deleter
 

Public Types

using Ptr = PtrIn
 

Public Member Functions

 ManagedARAHandle (ARA::Host::DocumentController &dc, Ptr ptr) noexcept
 Constructor.
 
auto & getDocumentController () const
 Returns the host side DocumentController reference.
 
Ptr getPluginRef () const
 Returns the plugin side reference to the model object.
 

Private Attributes

std::unique_ptr< std::remove_pointer_t< Ptr >, Deleterhandle
 

Detailed Description

template<typename Base, typename PtrIn>
class juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >

This class is used by the various ARA model object helper classes, such as MusicalContext, AudioSource etc.

It helps with deregistering the model objects from the DocumentController when the lifetime of the helper class object ends.

You shouldn't use this class directly but instead inherit from the helper classes.

@tags{ARA}

Member Typedef Documentation

◆ Ptr

template<typename Base , typename PtrIn >
using juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >::Ptr = PtrIn

Constructor & Destructor Documentation

◆ ManagedARAHandle()

template<typename Base , typename PtrIn >
juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >::ManagedARAHandle ( ARA::Host::DocumentController &  dc,
Ptr  ptr 
)
inlinenoexcept

Constructor.

Member Function Documentation

◆ getDocumentController()

template<typename Base , typename PtrIn >
auto & juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >::getDocumentController ( ) const
inline

Returns the host side DocumentController reference.

References juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >::handle.

◆ getPluginRef()

template<typename Base , typename PtrIn >
Ptr juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >::getPluginRef ( ) const
inline

Returns the plugin side reference to the model object.

References juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >::handle.

Member Data Documentation

◆ handle

template<typename Base , typename PtrIn >
std::unique_ptr<std::remove_pointer_t<Ptr>, Deleter> juce::ARAHostModel::ManagedARAHandle< Base, PtrIn >::handle
private

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