logUtilities.h File Reference

Header containing utilities for logging. More...

#include "HAL/UnrealMemory.h"
#include "Kismet/GameplayStatics.h"
#include "Kismet/KismetSystemLibrary.h"

Include dependency graph for logUtilities.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	__FILENAME__   (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
	Output Filename.
#define	__LOG_INFO__   FString(__FILENAME__).Append(TEXT("@")).Append(FString::FromInt(__LINE__)).Append(TEXT(", ")).Append(RCLUE_FUNC_LOG)
	Log info joint with , More...
#define	UE_LOG_WITH_INFO(CategoryName, Verbosity, ...)
#define	UE_LOG_WITH_INFO_SHORT(CategoryName, Verbosity, ...)
#define	UE_LOG_WITH_INFO_NAMED(CategoryName, Verbosity, ...)
#define	UE_LOG_WITH_INFO_SHORT_NAMED(CategoryName, Verbosity, ...)
#define	UE_LOG_THROTTLE(InRate, InLastHit, ...)
	UE_LOG_THROTTLE will print a message at most once per InRate. More...
#define	UE_LOG_WITH_INFO_THROTTLE(InRate, InLastHit, ...)
	UE_LOG_WITH_INFO_THROTTLE will print a message at most once per InRate. More...
#define	UE_LOG_WITH_INFO_SHORT_THROTTLE(InRate, InLastHit, ...)
	UE_LOG_WITH_INFO_SHORT_THROTTLE will print a message at most once per InRate. More...
#define	UE_LOG_WITH_INFO_NAMED_THROTTLE(InRate, InLastHit, ...)
	UE_LOG_WITH_INFO_NAMED_THROTTLE will print a message at most once per InRate. More...
#define	UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE(InRate, InLastHit, ...)
	UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE will print a message at most once per InRate. More...

Detailed Description

Header containing utilities for logging.

Todo:

should be in different Plugin since this is not directly related rclUE

Copyright

Copyright 2020-2022 Rapyuta Robotics Co., Ltd.

Macro Definition Documentation

__LOG_INFO__

#define __LOG_INFO__   FString(__FILENAME__).Append(TEXT("@")).Append(FString::FromInt(__LINE__)).Append(TEXT(", ")).Append(RCLUE_FUNC_LOG)

Log info joint with ,

SIG is defined at GeneratedTypeName.h

UE_LOG_THROTTLE

#define UE_LOG_THROTTLE	(		InRate,
			InLastHit,
			...
	)

UE_LOG_THROTTLE will print a message at most once per InRate.

Parameters

InRate,time	interval to print a message
InLastHit,last	time a message was printed

UE_LOG_WITH_INFO

#define UE_LOG_WITH_INFO	(		CategoryName,
			Verbosity,
			...
	)

UE_LOG with function info with FUNCTION and LINE .

Parameters

CategoryName	name of the logging category
Verbosity,verbosity	level to test against
Format,format	text

UE_LOG_WITH_INFO_NAMED

#define UE_LOG_WITH_INFO_NAMED	(		CategoryName,
			Verbosity,
			...
	)

UE_LOG_WITH_INFO with GetName()

Parameters

CategoryName	name of the logging category
Verbosity,verbosity	level to test against
Format,format	text

UE_LOG_WITH_INFO_NAMED_THROTTLE

#define UE_LOG_WITH_INFO_NAMED_THROTTLE	(		InRate,
			InLastHit,
			...
	)

UE_LOG_WITH_INFO_NAMED_THROTTLE will print a message at most once per InRate.

Parameters

InRate,time	interval to print a message
InLastHit,last	time a message was printed

UE_LOG_WITH_INFO_SHORT

#define UE_LOG_WITH_INFO_SHORT	(		CategoryName,
			Verbosity,
			...
	)

UE_LOG with function info with <class name>::<func name><line number> .

Parameters

CategoryName	name of the logging category
Verbosity,verbosity	level to test against
Format,format	text

UE_LOG_WITH_INFO_SHORT_NAMED

#define UE_LOG_WITH_INFO_SHORT_NAMED	(		CategoryName,
			Verbosity,
			...
	)

UE_LOG_WITH_INFO_SHORT with GetName()

Parameters

CategoryName	name of the logging category
Verbosity,verbosity	level to test against
Format,format	text

UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE

#define UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE	(		InRate,
			InLastHit,
			...
	)

UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE will print a message at most once per InRate.

Parameters

InRate,time	interval to print a message
InLastHit,last	time a message was printed

UE_LOG_WITH_INFO_SHORT_THROTTLE

#define UE_LOG_WITH_INFO_SHORT_THROTTLE	(		InRate,
			InLastHit,
			...
	)

UE_LOG_WITH_INFO_SHORT_THROTTLE will print a message at most once per InRate.

Parameters

InRate,time	interval to print a message
InLastHit,last	time a message was printed

UE_LOG_WITH_INFO_THROTTLE

#define UE_LOG_WITH_INFO_THROTTLE	(		InRate,
			InLastHit,
			...
	)

UE_LOG_WITH_INFO_THROTTLE will print a message at most once per InRate.

Parameters

InRate,time	interval to print a message
InLastHit,last	time a message was printed