TSubscriberDataStore

Generalized scope- and executor-keyed data store.

API > API/Plugins > API/Plugins/SubsonicCore

Generalized scope- and executor-keyed data store. Stores a DataType instance per scope level (Global, Executor) and provides convenience accessors, executor tracking, and iteration.

   
Name TSubscriberDataStore
Type class
Header File /Engine/Plugins/Experimental/Subsonic/Source/SubsonicCore/Public/SubsonicSubscriberDataStore.h
Include Path #include "SubsonicSubscriberDataStore.h"

Syntax

template<typename DataType>  
class TSubscriberDataStore

Typedefs

Name Type Remarks Include Path
FDataMap TMap< FName, DataType >   SubsonicSubscriberDataStore.h
FKeyDataMapPair TPair< FExecutorScopeKey, FDataMap >   SubsonicSubscriberDataStore.h
FNameDataPair TPair< FName, DataType >   SubsonicSubscriberDataStore.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ExecutorDataStore TMap< FExecutorScopeKey, FDataMap >   SubsonicSubscriberDataStore.h  
GlobalStore FDataMap   SubsonicSubscriberDataStore.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Empty ()

 Empties all scoped stores. SubsonicSubscriberDataStore.h  

void Empty ( TFunctionRef< void(FName, DataType&)> ReleaseFunc
)

 Empties all scoped stores, running the provided release function on all data values prior to destruction. SubsonicSubscriberDataStore.h  

DataType * Find ( FName GlobalName
)

 Finds associated data with a given global identifier. SubsonicSubscriberDataStore.h  

const DataType * Find ( FName GlobalName
) const

 Finds data associated with a given global identifier. SubsonicSubscriberDataStore.h  

DataType * Find ( const FExecutorScopeKey& Key,
FName Name
)

 Finds data associated with a given executor and name. SubsonicSubscriberDataStore.h  

const DataType * Find ( const FExecutorScopeKey& Key,
FName Name
) const

 Finds data associated with a given executor and name. SubsonicSubscriberDataStore.h  

DataType & FindOrAdd ( FName Name
)

 Finds or adds data associated with a given global identifier. SubsonicSubscriberDataStore.h  

DataType & FindOrAdd ( const FExecutorScopeKey& Key,
FName Name
)

 Finds or adds data associated with a given executor & name. SubsonicSubscriberDataStore.h  

void ForEach ( const FExecutorScopeKey& InKey,
TFunctionRef< void(FName, DataType&)> InFunc
) const

 Iterate on all data values associated with the given key with all names. SubsonicSubscriberDataStore.h  

void ForEach ( const FExecutorScopeKey& InKey,
TFunctionRef< void(FName, DataType&)> InFunc
)

 Iterate on all data values associated with the given key with all names. SubsonicSubscriberDataStore.h  

void ForEach ( TFunctionRef< void(FName, const DataType&)> InFunc
) const

 Iterate on all values at global scope with all names. SubsonicSubscriberDataStore.h  

void ForEach ( TFunctionRef< void(const FExecutorScopeKey&, const FName&, DataType&)> InFunc
)

 Iterate on all executor-scoped data maps with their associated keys. SubsonicSubscriberDataStore.h  

void ForEach ( TFunctionRef< void(const FExecutorScopeKey&, const FName&, const DataType&)> InFunc
) const

 Iterate on all executor-scoped data with their associated keys. SubsonicSubscriberDataStore.h  

void ForEach ( TFunctionRef< void(FName, DataType&)> InFunc
)

 Iterate on all values at global scope with all names. SubsonicSubscriberDataStore.h  

int32 Remove ( const FExecutorScopeKey& Key
)

 Removes all named data at the executor scope level. SubsonicSubscriberDataStore.h  

int32 Remove ( FName Name
)

 Removes the named data at the global scope level. SubsonicSubscriberDataStore.h  

int32 Remove ( const FExecutorScopeKey& Key,
FName Name
)

 Removes data associated with the given name at the executor scope level. SubsonicSubscriberDataStore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page