UFtsBenchmarkFunctionLibrary Class Reference

Utility functions for the benchmark plugin, mostly file related. More...

#include <FtsBenchmarkFunctionLibrary.h>

Inheritance diagram for UFtsBenchmarkFunctionLibrary:

Static Public Member Functions
static bool	SaveBenchmarkToJsonFile (const FFtsBenchmarkResult &Result, FString FilePath)
	Saves recorded benchmark data into a json file.
static bool	LoadBenchmarkFromJsonFile (FString FilePath, FFtsBenchmarkResult &OutResult)
	Reads a json file and writes its data to a result struct.
static bool	SaveResultListToJsonFile (const FFtsBenchmarkResultList &Results, const FString &FilePath)
	Saves all results to json file.
static bool	LoadBenchmarkListFromJsonFile (FString FilePath, FFtsBenchmarkResultList &OutResult)
	Reads a json file containing results into a result list.
static bool	ShowOpenDirectoryDialogue (const FString &DialogTitle, const FString &DefaultPath, FString &OutDirectoryPath)
static bool	ShowOpenBenchmarkDialogue (const FString &DialogTitle, const FString &DefaultPath, FString &OutFilePath)
static void	GetBenchmarkFilesInDirectory (const FString &DirectoryPath, TArray< FString > &OutFileNames)
static bool	IsAutomationTest (const FPrimaryAssetId &BenchmarkId)
	Tries to read the asset data of a given benchmark to see if it is marked as an automation test.

Detailed Description

Utility functions for the benchmark plugin, mostly file related.

Member Function Documentation

IsAutomationTest()

bool UFtsBenchmarkFunctionLibrary::IsAutomationTest ( const FPrimaryAssetId & BenchmarkId )

static

Tries to read the asset data of a given benchmark to see if it is marked as an automation test.

Parameters

BenchmarkId

Id of benchmark asset

Returns

True if benchmark asset has automation test flag set

LoadBenchmarkFromJsonFile()

bool UFtsBenchmarkFunctionLibrary::LoadBenchmarkFromJsonFile ( FString FilePath, FFtsBenchmarkResult & OutResult )

static

Reads a json file and writes its data to a result struct.

Parameters

FilePath	Full path including extension of file to load
OutResult	Loaded data

Returns

True if successful

LoadBenchmarkListFromJsonFile()

bool UFtsBenchmarkFunctionLibrary::LoadBenchmarkListFromJsonFile ( FString FilePath, FFtsBenchmarkResultList & OutResult )

static

Reads a json file containing results into a result list.

Parameters

FilePath	Absolute file path to json file including extension
OutResult	Benchmark list contents of the file

Returns

True if json was read successfully

SaveBenchmarkToJsonFile()

bool UFtsBenchmarkFunctionLibrary::SaveBenchmarkToJsonFile ( const FFtsBenchmarkResult & Result, FString FilePath )

static

Saves recorded benchmark data into a json file.

Parameters

Result	Data to save to file
FilePath	Full path including extension of file to save

Returns

True if successful

SaveResultListToJsonFile()

bool UFtsBenchmarkFunctionLibrary::SaveResultListToJsonFile ( const FFtsBenchmarkResultList & Results, const FString & FilePath )

static

Saves all results to json file.

Parameters

Results	Data to save to file
FilePath	Full path including extension of file to save

Returns

True if successful

---

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

• Plugins/FtsBenchmark/Source/FtsBenchmark/Public/FtsBenchmarkFunctionLibrary.h
• Plugins/FtsBenchmark/Source/FtsBenchmark/Private/FtsBenchmarkFunctionLibrary.cpp