Public Member Functions | List of all members
ARAFactoryWrapper Class Reference

Encapsulates an ARAFactory pointer and makes sure that it remains in a valid state for the lifetime of the ARAFactoryWrapper object. More...

Public Member Functions

 ARAFactoryWrapper ()=default
 
 ARAFactoryWrapper (std::shared_ptr< const ARA::ARAFactory > factoryIn)
 
const ARA::ARAFactory * get () const noexcept
 Returns the contained ARAFactory pointer, which can be a nullptr. More...
 

Detailed Description

Encapsulates an ARAFactory pointer and makes sure that it remains in a valid state for the lifetime of the ARAFactoryWrapper object.

Constructor & Destructor Documentation

◆ ARAFactoryWrapper() [1/2]

ARAFactoryWrapper::ARAFactoryWrapper ( )
default

◆ ARAFactoryWrapper() [2/2]

ARAFactoryWrapper::ARAFactoryWrapper ( std::shared_ptr< const ARA::ARAFactory >  factoryIn)
explicit

Used by the framework to encapsulate ARAFactory pointers loaded from plugins.

Member Function Documentation

◆ get()

const ARA::ARAFactory* ARAFactoryWrapper::get ( ) const
noexcept

Returns the contained ARAFactory pointer, which can be a nullptr.

The validity of the returned pointer is only guaranteed for the lifetime of this wrapper.


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