CSVFile.h

Go to the documentation of this file.

// Copyright (c) 2024 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
 
#include <fstream>
 
#include "CSVFile.generated.h"
 
UENUM(BlueprintType)
enum class ECSVDelimiter : uint8
{
    Comma,
    Semicolon,
    Tab
};
 
UENUM(BlueprintType)
enum class FCSVFileWriteOptions : uint8
{
    Immediate = 0 UMETA(DisplayName = "Immediate"),
    Queue = 1 UMETA(DisplayName = "Queue")
};
 
USTRUCT(BlueprintType)
struct FCSVFileSettings
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    ECSVDelimiter Delimiter = ECSVDelimiter::Comma;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool Append = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool CreateUnique = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FCSVFileWriteOptions FileWriteOption = FCSVFileWriteOptions::Immediate;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    int32 QueueSize = 256;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FString CustomPath;
};
 
UCLASS()
class AGRARSENSE_API UCSVFile : public UObject
{
    GENERATED_BODY()
 
public:
    static UCSVFile* CreateCSVFile(const FString& FileNameWithoutExtension, const FCSVFileSettings& Settings);
 
    void WriteRow(const TArray<FString>& Cells);
 
    void Close();
 
    void Destroy();
 
private:
 
    void Create(const FString& FileNameWithoutExtension, const FCSVFileSettings& Settings);
 
    void OpenStream();
 
    void WriteRaw(const FString& Line);
 
    TArray<FString> PendingRows;
 
    FString FilePath;
 
    FCSVFileSettings CurrentSettings;
 
    std::ofstream CSVStream;
 
};