UCSVFile Class Reference

#include <CSVFile.h>

Inheritance diagram for UCSVFile:

Collaboration diagram for UCSVFile:

Public Member Functions
void	WriteRow (const TArray< FString > &Cells)
void	Close ()
void	Destroy ()

Static Public Member Functions
static UCSVFile *	CreateCSVFile (const FString &FileNameWithoutExtension, const FCSVFileSettings &Settings)

Private Member Functions
void	Create (const FString &FileNameWithoutExtension, const FCSVFileSettings &Settings)
void	OpenStream ()
void	WriteRaw (const FString &Line)

Private Attributes
TArray< FString >	PendingRows
FString	FilePath
FCSVFileSettings	CurrentSettings
std::ofstream	CSVStream

Detailed Description

CSV file writer utility Usage example:

FCSVFileSettings Settings; UCSVFile* CSV = UCSVFile::CreateCSVFile("MyCoolCSVFile", Settings); CSV->WriteRow({ TEXT("Time"), TEXT("X"), TEXT("Y"), TEXT("Z") }); CSV->WriteRow({ TEXT("12.3"), TEXT("100"), TEXT("200"), TEXT("300") }); CSV->Destroy();

Definition at line 65 of file CSVFile.h.

Member Function Documentation

Close()

void UCSVFile::Close

(

)

Definition at line 116 of file CSVFile.cpp.

{
    if (CSVStream.is_open())
    {
        // If we have queued rows, write them out
        if (CurrentSettings.FileWriteOption == FCSVFileWriteOptions::Queue)
        {
            for (const FString& Row : PendingRows)
            {
                WriteRaw(Row);
            }
            PendingRows.Empty();
        }
 
        CSVStream.close();
    }
}

References CSVStream, CurrentSettings, FCSVFileSettings::FileWriteOption, PendingRows, Queue, and WriteRaw().

Referenced by Destroy(), and ATagger::ExportObjectLocationsToCSV().

Create()

void UCSVFile::Create ( const FString &  FileNameWithoutExtension, const FCSVFileSettings &  Settings  )

private

Definition at line 26 of file CSVFile.cpp.

{
    CurrentSettings = Settings;
 
    // Simulator data directory for this run. Returns SIMULATOR_ROOT/Data/Run_{NUM}
    FString DataDirectory = UAgrarsensePaths::GetDataFolder();
 
    FString BasePath = Settings.CustomPath.IsEmpty() ? DataDirectory + "/CSV/" : Settings.CustomPath;
    IPlatformFile& PlatformFile = FPlatformFileManager::Get().GetPlatformFile();
    if (!PlatformFile.DirectoryExists(*BasePath))
    {
        PlatformFile.CreateDirectoryTree(*BasePath);
    }
 
    FString FullPath = FPaths::Combine(*BasePath, FileNameWithoutExtension + TEXT(".csv"));
    UE_LOG(LogTemp, Warning, TEXT("FullPath: %s"), *FullPath);
 
    if (Settings.CreateUnique)
    {
        int32 Counter = 0;
        while (FPaths::FileExists(FullPath))
        {
            FullPath = FPaths::Combine(*BasePath, FileNameWithoutExtension + FString::Printf(TEXT("_%d.csv"), Counter++));
        }
    }
 
    if (Settings.FileWriteOption == FCSVFileWriteOptions::Queue) 
    {
        PendingRows.Reserve(Settings.QueueSize);
    }
 
    FilePath = FullPath;
 
    OpenStream();
}

References FCSVFileSettings::CreateUnique, CurrentSettings, FCSVFileSettings::CustomPath, FilePath, FCSVFileSettings::FileWriteOption, UAgrarsensePaths::GetDataFolder(), OpenStream(), PendingRows, Queue, and FCSVFileSettings::QueueSize.

Referenced by CreateCSVFile().

CreateCSVFile()

UCSVFile * UCSVFile::CreateCSVFile ( const FString &  FileNameWithoutExtension, const FCSVFileSettings &  Settings  )

static

Definition at line 15 of file CSVFile.cpp.

{
    UCSVFile* CSVFile = NewObject<UCSVFile>(UCSVFile::StaticClass());
    CSVFile->AddToRoot();
    if (CSVFile)
    {
        CSVFile->Create(FileNameWithoutExtension, Settings);
    }
    return CSVFile;
}

References Create().

Referenced by ATagger::CreateCSVFile(), and AInstancedRendererManager::ExportTreesAsCSV().

Destroy()

void UCSVFile::Destroy

(

)

Definition at line 134 of file CSVFile.cpp.

{
    Close();
    ConditionalBeginDestroy();
}

References Close().

Referenced by AInstancedRendererManager::ExportTreesAsCSV().

OpenStream()

void UCSVFile::OpenStream ( )

private

Definition at line 62 of file CSVFile.cpp.

{
    if (CSVStream.is_open())
    {
        CSVStream.close();
    }
 
    std::ios_base::openmode Mode = std::ios::out;
    if (CurrentSettings.Append)
    {
        Mode |= std::ios::app;
    }
 
    CSVStream.open(TCHAR_TO_UTF8(*FilePath), Mode);
}

References FCSVFileSettings::Append, CSVStream, CurrentSettings, and FilePath.

Referenced by Create(), WriteRaw(), and WriteRow().

WriteRaw()

void UCSVFile::WriteRaw ( const FString &  Line )

private

Definition at line 108 of file CSVFile.cpp.

{
    if (!CSVStream.is_open()) OpenStream();
    if (!CSVStream.is_open()) return;
 
    CSVStream << TCHAR_TO_UTF8(*Line) << std::endl;
}

References CSVStream, and OpenStream().

Referenced by Close(), and WriteRow().

WriteRow()

void UCSVFile::WriteRow

(

const TArray< FString > &

Cells

)

Definition at line 78 of file CSVFile.cpp.

{
    if (!CSVStream.is_open()) OpenStream();
    if (!CSVStream.is_open()) return;
 
    // Determine delimiter
    FString Delimiter = TEXT(",");
    if (CurrentSettings.Delimiter == ECSVDelimiter::Semicolon)
    {
        Delimiter = TEXT(";");
    }
    else if (CurrentSettings.Delimiter == ECSVDelimiter::Tab)
    {
        Delimiter = TEXT("\t");
    }
 
    // Join values using chosen delimiter
    FString Line = FString::Join(Cells, *Delimiter);
 
    if (CurrentSettings.FileWriteOption == FCSVFileWriteOptions::Immediate)
    {
        WriteRaw(Line);  // Write the line immediately
    }
    else if (CurrentSettings.FileWriteOption == FCSVFileWriteOptions::Queue)
    {
        // Queue the line for later
        PendingRows.Add(Line);
    }
}

References CSVStream, CurrentSettings, FCSVFileSettings::Delimiter, FCSVFileSettings::FileWriteOption, Immediate, OpenStream(), PendingRows, Queue, Semicolon, Tab, and WriteRaw().

Referenced by ATagger::CreateCSVFile(), AInstancedRendererManager::ExportTreesAsCSV(), and ATagger::WriteComponentToCSV().

Member Data Documentation

CSVStream

std::ofstream UCSVFile::CSVStream

private

Definition at line 92 of file CSVFile.h.

Referenced by Close(), OpenStream(), WriteRaw(), and WriteRow().

CurrentSettings

FCSVFileSettings UCSVFile::CurrentSettings

private

Definition at line 90 of file CSVFile.h.

Referenced by Close(), Create(), OpenStream(), and WriteRow().

FilePath

FString UCSVFile::FilePath

private

Definition at line 88 of file CSVFile.h.

Referenced by Create(), and OpenStream().

PendingRows

TArray<FString> UCSVFile::PendingRows

private

Definition at line 86 of file CSVFile.h.

Referenced by Close(), Create(), and WriteRow().

---

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

• Unreal/Agrarsense/Source/Agrarsense/Logging/CSVFile.h
• Unreal/Agrarsense/Source/Agrarsense/Logging/CSVFile.cpp