IAnalysisCache

Analysis cache

Unreal Engine C++ API Reference > Developer > TraceServices > TraceServices > Model

References

   
Module TraceServices
Header /Engine/Source/Developer/TraceServices/Public/TraceServices/Model/AnalysisCache.h
Include #include "TraceServices/Model/AnalysisCache.h"

Syntax

class IAnalysisCache  

Remarks

Analysis cache

Allows users of the system to create tracked fixed size blocks associated with a "cache id", created using a string. After creating block(s) users are free to write arbitrary data into them. Once all references to the block has been dropped the buffer is committed to persistent storage (e.g. cache file).

On consecutive analysis sessions the blocks can be retrieved using the cache id and the block index. Any block can be requested at any point in the session in any order.

Analysis is not thread safe and is designed to be used from the analysis thread only.

The container classes TraceServices::TCachedPagedArray or TraceServices::FCachedStringStore are provided as user facing abstractions on top of the cache.

Destructors

Type Name Description
  ~IAnalysisCache ()  

Functions

Type Name Description
FSharedBuffe... CreateBlocks ( FCacheId CacheId, uint32 Count ) Create blocks of tracked memory.
FSharedBuffe... GetBlocks ( FCacheId CacheId, uint32 BlockIndexStart, uint32 BlockCount ) Load blocks into memory.
FCacheId GetCacheId ( const TCHAR* Name, uint16 Flags ) Returns the unique id for a named entry. If the entry does not yet exists and new id is reserved.
FMutableMemo... GetUserData ( FCacheId CacheId ) Gets a pointer to the user data a given cache id.

Constants

Name Description
BlockSizeBytes Block size in bytes

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library