UAgrarsensePaths Class Reference

#include <AgrarsensePaths.h>

Inheritance diagram for UAgrarsensePaths:

Collaboration diagram for UAgrarsensePaths:

Static Public Member Functions
static FString	GetProjectRootFolder ()
static FString	GetContentFolderPath ()
static FString	GetDataFolder ()
static FString	GetExamplesFolder ()

Static Private Attributes
static FString	DataPathForThisRun = ""

Friends
class	AAgrarsenseGameModeBase

Detailed Description

Definition at line 14 of file AgrarsensePaths.h.

Member Function Documentation

GetContentFolderPath()

FString UAgrarsensePaths::GetContentFolderPath ( )

static

Get project content folder path

Returns

project content folder path

Definition at line 32 of file AgrarsensePaths.cpp.

{
    FString RootPath = GetProjectRootFolder();
    FString ContentFolder = RootPath + "Unreal/Agrarsense/Content/";
 
    return ContentFolder;
}

References GetProjectRootFolder().

GetDataFolder()

FString UAgrarsensePaths::GetDataFolder ( )

static

Get AGRARSENSE data folder

Returns

data folder path

Definition at line 40 of file AgrarsensePaths.cpp.

{
    if (!DataPathForThisRun.IsEmpty())
    {
        return DataPathForThisRun;
    }
 
    IPlatformFile& PlatformFile = FPlatformFileManager::Get().GetPlatformFile();
 
    FString RootPath = GetProjectRootFolder();
    FString DataRoot = RootPath + "Data";
 
    if (!FPaths::DirectoryExists(DataRoot))
    {
        PlatformFile.CreateDirectory(*DataRoot);
    }
 
    // Continue with the rest of the logic
    FString BaseDataFolderPath = DataRoot + "/Run";
 
    int32 RunIndex = 0;
    do
    {
        DataPathForThisRun = BaseDataFolderPath + FString::FromInt(RunIndex);
        RunIndex++;
    } while (PlatformFile.DirectoryExists(*DataPathForThisRun));
 
    DataPathForThisRun += "/";    // Append slash to the path
 
    PlatformFile.CreateDirectory(*DataPathForThisRun);
 
    return DataPathForThisRun;
}

References DataPathForThisRun, and GetProjectRootFolder().

Referenced by ALidarManager::BeginPlay(), ULogFile::Create(), ASensor::CreateDataSavePath(), and USimulatorJsonExporter::CreateUniqueFilePath().

GetExamplesFolder()

FString UAgrarsensePaths::GetExamplesFolder ( )

static

Get AGRARSENSE Examples folder

Returns

data folder path

Definition at line 74 of file AgrarsensePaths.cpp.

{
    FString RootPath = GetProjectRootFolder();
 
    FString DataFolderPath = RootPath + "Examples/";
 
    // Check if dir exists, if it doesn't let's create it.
    IPlatformFile& PlatformFile = FPlatformFileManager::Get().GetPlatformFile();
    if (!PlatformFile.DirectoryExists(*DataFolderPath))
    {
        PlatformFile.CreateDirectory(*DataFolderPath);
    }
 
    return DataFolderPath;
}

References GetProjectRootFolder().

GetProjectRootFolder()

FString UAgrarsensePaths::GetProjectRootFolder ( )

static

Get project root folder path. When playing in Editor this means Git root path (example. C:/Agrarsense/). when playing on packaged build this means SOME_PATH/Agrarsense.exe path.

Returns

FString path to project root folder.

Definition at line 17 of file AgrarsensePaths.cpp.

{
    FString ProjectRootPath = FPaths::ConvertRelativePathToFull(FPaths::ProjectDir());
 
    // How many characters to remove so we get Actual project root folder
    int CharsToRemove = 11;
#if WITH_EDITOR
    CharsToRemove = 18;
#endif
 
    ProjectRootPath.RemoveAt(ProjectRootPath.Len() - CharsToRemove, CharsToRemove, true);
 
    return ProjectRootPath;
}

Referenced by GetContentFolderPath(), GetDataFolder(), and GetExamplesFolder().

Friends And Related Function Documentation

AAgrarsenseGameModeBase

friend class AAgrarsenseGameModeBase

friend

Definition at line 52 of file AgrarsensePaths.h.

Member Data Documentation

DataPathForThisRun

FString UAgrarsensePaths::DataPathForThisRun = ""

staticprivate

Definition at line 54 of file AgrarsensePaths.h.

Referenced by GetDataFolder().

---

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

• Unreal/Agrarsense/Source/Agrarsense/Game/AgrarsensePaths.h
• Unreal/Agrarsense/Source/Agrarsense/Game/AgrarsensePaths.cpp