SimulatorLog Class Reference

#include <SimulatorLog.h>

Collaboration diagram for SimulatorLog:

Static Public Member Functions
static void	Log (const FString &Message, bool LogToTextFile=true, bool LogToROS=true)

Static Private Member Functions
static void	Create ()
static void	Shutdown ()

Static Private Attributes
static ULogFile *	SimulatorLogFile = nullptr

Friends
class	AAgrarsenseGameModeBase

Detailed Description

Static class for logging Simulator messages to console, text file and ROS.

Definition at line 19 of file SimulatorLog.h.

Member Function Documentation

Create()

void SimulatorLog::Create ( )

staticprivate

Create the log file.

Definition at line 41 of file SimulatorLog.cpp.

{
    if (!IsValid(SimulatorLogFile))
    {
        // Find or create Agrarsense.txt file
        FLogFileSettings Settings;
        Settings.FileCreationOptions = FFileCreationOptions::Append;
        Settings.FileWriteOptions = FFileWriteOptions::Queue;
        Settings.QueueLength = 10;
        Settings.KeepFileOpen = false;
        SimulatorLogFile = ULogFile::CreateLogFile("Agrarsense", Settings);
    }
}

References Append, ULogFile::CreateLogFile(), FLogFileSettings::FileCreationOptions, FLogFileSettings::FileWriteOptions, FLogFileSettings::KeepFileOpen, Queue, FLogFileSettings::QueueLength, and SimulatorLogFile.

Referenced by AAgrarsenseGameModeBase::SpawnNeededActorsInitGame().

Log()

void SimulatorLog::Log ( const FString &  Message, bool  LogToTextFile = true, bool  LogToROS = true  )

static

Logs a message.

Parameters

Message	The message to log.
LogToTextFile	Whether to log to a text file.
LogToROS	Whether to log to ROS.

Definition at line 14 of file SimulatorLog.cpp.

{
    if (!IsInGameThread())
    {
        // If not in game thread, call itself back within the game thread.
        AsyncTask(ENamedThreads::GameThread, [Message, LogToTextFile, LogToROS]()
        {
            Log(Message, LogToTextFile, LogToROS);
        });
        return;
    }
 
    if (SimulatorLogFile && SimulatorLogFile->IsValidLowLevel() && LogToTextFile)
    {
        SimulatorLogFile->Write(Message);
    }
 
    if (LogToROS)
    {
        UInfoTopic::SendMessage(Message);
    }
 
#if WITH_EDITOR
    UE_LOG(LogTemp, Warning, TEXT("SimulatorLog.cpp: %s"), *Message);
#endif
}

References Log(), UInfoTopic::SendMessage(), SimulatorLogFile, and ULogFile::Write().

Referenced by ACamera::AddPostProcessingMaterial(), ASensor::BeginPlay(), AOverlapSensor::BuildAndSendMessage(), UAgrarsenseSettings::ChangeMapByName(), ALidar::ChangeParameters(), ASensor::CreateROSTopic(), UAssetLibrary::DestroyAllWalkers(), ADeletionVolume::DestroyOverlappingActors(), AAgrarsenseGameModeBase::EndPlay(), ASensor::EndPlay(), USimulatorJsonExporter::ExportInstancedActorsToJSON(), USimulatorJsonExporter::ExportSensorToJSON(), USimulatorJsonExporter::ExportVehicleAndSensorsToJSON(), USimulatorJsonExporter::ExportWalkerToJSON(), USimulatorJsonExporter::ExportWeatherToJSON(), UROSCommands::HandlePrintAvailableCommands(), UROSCommands::HandlePrintMaps(), UROSCommands::HandleTryDestroyObjectByID(), Log(), ACollisionSensor::OnCollisionEvent(), USimulatorJsonParser::ParseAndOperateJSONFile(), USimulatorJsonParser::ParseAndSetSemanticColors(), UROSCommands::ParseIncomingMessage(), UAgrarsenseSettings::PauseSimulation(), UROSCommands::PrintActorInformation(), IActorInformation::PrintAllIds(), UAgrarsenseGameInstance::ROSBridgeConnected(), UAgrarsenseGameInstance::ROSBridgeDisconnected(), ACamera::SaveImageToDisk(), UAgrarsenseSettings::SetGlobalTimeDilation(), AOverlapSensor::SetOverlapBounds(), AOverlapSensor::SetOverlapRelativePosition(), UAgrarsenseSettings::SetQualityLevel(), UAgrarsenseSettings::SetUltraWithRaytracingLevel(), UAgrarsenseSettings::SetWorldRendering(), USimulatorLogFunctionLibrary::SimulatorLog(), AAgrarsenseGameModeBase::SpawnNeededActorsInitGame(), USimulatorJsonParser::SpawnSensorWorld(), USimulatorJsonParser::SpawnWalker(), UAssetLibrary::SpawnWalker(), and UAgrarsenseSettings::UnPauseSimulation().

Shutdown()

void SimulatorLog::Shutdown ( )

staticprivate

Destroy the log file.

Definition at line 55 of file SimulatorLog.cpp.

{
    if (IsValid(SimulatorLogFile))
    {
        SimulatorLogFile->Destroy();
        SimulatorLogFile = nullptr;
    }
}

References ULogFile::Destroy(), and SimulatorLogFile.

Referenced by AAgrarsenseGameModeBase::EndPlay().

Friends And Related Function Documentation

AAgrarsenseGameModeBase

friend class AAgrarsenseGameModeBase

friend

Definition at line 34 of file SimulatorLog.h.

Member Data Documentation

SimulatorLogFile

ULogFile * SimulatorLog::SimulatorLogFile = nullptr

staticprivate

Definition at line 47 of file SimulatorLog.h.

Referenced by Create(), Log(), and Shutdown().

---

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

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