Classes | Public Member Functions | List of all members
SharedPoolBase< DataType > Class Template Reference

Implementations of the data pool. More...

Inheritance diagram for SharedPoolBase< DataType >:
PoolBase ControlledObject

Classes

class  ManagedPtr
 A ManagedPtr is a wrapper around a reference in the pool. More...
 

Public Member Functions

void clearData () override
 Clears the pool. More...
 
bool contains (int64 hashCode) const
 Checks if the hash code is used by the pool. More...
 
var getAdditionalData (PoolReference r) const override
 Every pool item has a storage object for additional metadata (eg. More...
 
Array< PoolReferencegetListOfAllReferences (bool includeEmbeddedButUnloadedReferences) const
 Creates a list of all cached data. More...
 
int getNumLoadedFiles () const override
 Returns the number of loaded files. More...
 
PoolReference getReference (int index) const override
 Returns the PoolReference at the given index. More...
 
String getStatistics () const
 Returns a statistic string with the size and memory usage of the pool. More...
 
ManagedPtr loadFromReference (PoolReference r, PoolHelpers::LoadingType loadingType)
 Loads a reference with the given LoadingType. More...
 
- Public Member Functions inherited from ControlledObject
 ControlledObject (MainController *m)
 Creates a new ControlledObject. More...
 
const MainControllergetMainController () const noexcept
 Provides read-only access to the main controller. More...
 
MainControllergetMainController () noexcept
 Provides write access to the main controller. More...
 

Detailed Description

template<class DataType>
class hise::SharedPoolBase< DataType >

Implementations of the data pool.

Member Function Documentation

void clearData ( )
inlineoverridevirtual

Clears the pool.

Implements PoolBase.

bool contains ( int64  hashCode) const
inline

Checks if the hash code is used by the pool.

Use this method with the hash code of a PoolReference.

var getAdditionalData ( PoolReference  r) const
inlineoverridevirtual

Every pool item has a storage object for additional metadata (eg.

the sample rate for audio files).

Implements PoolBase.

Array<PoolReference> getListOfAllReferences ( bool  includeEmbeddedButUnloadedReferences) const
inline

Creates a list of all cached data.

int getNumLoadedFiles ( ) const
inlineoverridevirtual

Returns the number of loaded files.

Implements PoolBase.

PoolReference getReference ( int  index) const
inlineoverridevirtual

Returns the PoolReference at the given index.

Implements PoolBase.

String getStatistics ( ) const
inline

Returns a statistic string with the size and memory usage of the pool.

ManagedPtr loadFromReference ( PoolReference  r,
PoolHelpers::LoadingType  loadingType 
)
inline

Loads a reference with the given LoadingType.

Use this whenever you need to access data, as it will check if the data was already cached.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.