FLogCategoryBase Struct Reference

#include <LogCategory.h>

Inheritance diagram for FLogCategoryBase:

Public Member Functions
UE_API	FLogCategoryBase (const FLogCategoryName &CategoryName, ELogVerbosity::Type DefaultVerbosity, ELogVerbosity::Type CompileTimeVerbosity)
UE_API	FLogCategoryBase (const TCHAR *CategoryName, ELogVerbosity::Type DefaultVerbosity, ELogVerbosity::Type CompileTimeVerbosity)
UE_API	~FLogCategoryBase ()
UE_FORCEINLINE_HINT constexpr bool	IsSuppressed (ELogVerbosity::Type VerbosityLevel) const
UE_API void	PostTrigger (ELogVerbosity::Type VerbosityLevel)
constexpr const FLogCategoryName &	GetCategoryName () const
constexpr ELogVerbosity::Type	GetVerbosity () const
UE_API void	SetVerbosity (ELogVerbosity::Type Verbosity)
constexpr ELogVerbosity::Type	GetCompileTimeVerbosity () const

Friends
class	FLogSuppressionImplementation
class	FLogScopedVerbosityOverride

Detailed Description

Base class for all log categories.

Constructor & Destructor Documentation

FLogCategoryBase() [1/2]

FLogCategoryBase::FLogCategoryBase	(	const FLogCategoryName &	CategoryName,
		ELogVerbosity::Type	DefaultVerbosity,
		ELogVerbosity::Type	CompileTimeVerbosity
	)

Constructor, registers with the log suppression system and sets up the default values.

Parameters

CategoryName	Name of the category.
DefaultVerbosity	Default verbosity used to filter this category at runtime.
CompileTimeVerbosity	Verbosity used to filter this category at compile time.

FLogCategoryBase() [2/2]

FLogCategoryBase::FLogCategoryBase	(	const TCHAR *	CategoryName,
		ELogVerbosity::Type	DefaultVerbosity,
		ELogVerbosity::Type	CompileTimeVerbosity
	)

Constructor, registers with the log suppression system and sets up the default values.

Parameters

CategoryName	Name of the category.
DefaultVerbosity	Default verbosity used to filter this category at runtime.
CompileTimeVerbosity	Verbosity used to filter this category at compile time.

~FLogCategoryBase()

FLogCategoryBase::~FLogCategoryBase

(

)

Destructor, unregisters from the log suppression system.

Member Function Documentation

GetCategoryName()

constexpr const FLogCategoryName & FLogCategoryBase::GetCategoryName ( ) const

inlineconstexpr

GetCompileTimeVerbosity()

constexpr ELogVerbosity::Type FLogCategoryBase::GetCompileTimeVerbosity ( ) const

inlineconstexpr

Gets the compile time verbosity.

GetVerbosity()

constexpr ELogVerbosity::Type FLogCategoryBase::GetVerbosity ( ) const

inlineconstexpr

Gets the working verbosity.

IsSuppressed()

UE_FORCEINLINE_HINT constexpr bool FLogCategoryBase::IsSuppressed ( ELogVerbosity::Type  VerbosityLevel ) const

inlineconstexpr

Should not generally be used directly. Tests the runtime verbosity and maybe triggers a debug break, etc.

PostTrigger()

void FLogCategoryBase::PostTrigger

(

ELogVerbosity::Type

VerbosityLevel

)

Called just after a logging statement being allow to print. Checks a few things and maybe breaks into the debugger.

SetVerbosity()

void FLogCategoryBase::SetVerbosity

(

ELogVerbosity::Type

Verbosity

)

Sets up the working verbosity and clamps to the compile time verbosity.

Friends And Related Symbol Documentation

FLogScopedVerbosityOverride

friend class FLogScopedVerbosityOverride

friend

FLogSuppressionImplementation

friend class FLogSuppressionImplementation

friend

---

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

• Engine/Source/Runtime/Core/Public/Logging/LogCategory.h
• Engine/Source/Runtime/Core/Private/Logging/LogCategory.cpp