#include <LiveLinkLog.h>

Public Member Functions
virtual	~FLiveLinkLog ()=default

virtual TPair< int32, FTimespan >	GetOccurrence (FName MessageID, FLiveLinkSubjectKey SubjectKey) const =0

virtual TPair< int32, FTimespan >	GetSelectedOccurrence () const =0

virtual void	GetLogCount (int32 &OutErrorCount, int32 &OutWarningCount, int32 &OutInfoCount) const =0

Static Public Member Functions
template<typename... ArgsType>
static void	Error (UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

template<typename... ArgsType>
static void	ErrorOnce (FName MessageID, const FLiveLinkSubjectKey &SubjectKey, UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

template<typename... ArgsType>
static void	Warning (UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

template<typename... ArgsType>
static void	WarningOnce (FName MessageID, const FLiveLinkSubjectKey &SubjectKey, UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

template<typename... ArgsType>
static void	Info (UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

template<typename... ArgsType>
static void	InfoOnce (FName MessageID, const FLiveLinkSubjectKey &SubjectKey, UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

template<typename... ArgsType>
static TSharedPtr< FTokenizedMessage >	TokenizedMessage (EMessageSeverity::Type Severity, UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

template<typename... ArgsType>
static TSharedPtr< FTokenizedMessage >	TokenizedMessageOnce (EMessageSeverity::Type Severity, FName MessageID, const FLiveLinkSubjectKey &SubjectKey, UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... > Format, ArgsType... Args)

static FLiveLinkLog *	GetInstance ()

Protected Member Functions
virtual void	LogMessage (EMessageSeverity::Type Severity, FName MessageID, const FLiveLinkSubjectKey &SubjectKey, FString &&Message)=0

virtual TSharedPtr< FTokenizedMessage >	CreateTokenizedMessage (EMessageSeverity::Type Severity, FName MessageID, const FLiveLinkSubjectKey &SubjectKey, FString &&Message)=0

Static Protected Attributes
static LIVELINKINTERFACE_API TUniquePtr< FLiveLinkLog >	Instance

Detailed Description

This class represents a log of LiveLink output each of which can be a rich tokenized message

Constructor & Destructor Documentation

◆ ~FLiveLinkLog()

virtual FLiveLinkLog::~FLiveLinkLog ( )

virtualdefault

Dtor

Member Function Documentation

◆ CreateTokenizedMessage()

virtual TSharedPtr< FTokenizedMessage > FLiveLinkLog::CreateTokenizedMessage	(	EMessageSeverity::Type	Severity,
		FName	MessageID,
		const FLiveLinkSubjectKey &	SubjectKey,
		FString &&	Message
	)

protectedpure virtual

◆ Error()

template<typename... ArgsType>

static void FLiveLinkLog::Error	(	UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write an error in to the LiveLink log.

◆ ErrorOnce()

template<typename... ArgsType>

static void FLiveLinkLog::ErrorOnce	(	FName	MessageID,
		const FLiveLinkSubjectKey &	SubjectKey,
		UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write a error in to the LiveLink log. If the error occurred more than once for that SubjectKey, a counter will indicate the number of time it did occurred.

◆ GetInstance()

static FLiveLinkLog * FLiveLinkLog::GetInstance ( )

inlinestatic

◆ GetLogCount()

virtual void FLiveLinkLog::GetLogCount	(	int32 &	OutErrorCount,
		int32 &	OutWarningCount,
		int32 &	OutInfoCount
	)		const

pure virtual

Get the total number of error, warning and info messages that occurred.

◆ GetOccurrence()

virtual TPair< int32, FTimespan > FLiveLinkLog::GetOccurrence	(	FName	MessageID,
		FLiveLinkSubjectKey	SubjectKey
	)		const

pure virtual

Get the number of time the message with the MessageID and SubjectKey occurred.

◆ GetSelectedOccurrence()

virtual TPair< int32, FTimespan > FLiveLinkLog::GetSelectedOccurrence ( ) const

pure virtual

Get the number of time the selected message occurred.

◆ Info()

template<typename... ArgsType>

static void FLiveLinkLog::Info	(	UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write an info in to the LiveLink log.

◆ InfoOnce()

template<typename... ArgsType>

static void FLiveLinkLog::InfoOnce	(	FName	MessageID,
		const FLiveLinkSubjectKey &	SubjectKey,
		UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write a info in to the LiveLink log. If the info occurred more than once for that SubjectKey, a counter will indicate the number of time it did occurred.

◆ LogMessage()

virtual void FLiveLinkLog::LogMessage	(	EMessageSeverity::Type	Severity,
		FName	MessageID,
		const FLiveLinkSubjectKey &	SubjectKey,
		FString &&	Message
	)

protectedpure virtual

◆ TokenizedMessage()

template<typename... ArgsType>

static TSharedPtr< FTokenizedMessage > FLiveLinkLog::TokenizedMessage	(	EMessageSeverity::Type	Severity,
		UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write an message in to the LiveLink log. Will returns a valid TokenizedMessage if a new TokenizedMessage was created.

◆ TokenizedMessageOnce()

template<typename... ArgsType>

static TSharedPtr< FTokenizedMessage > FLiveLinkLog::TokenizedMessageOnce	(	EMessageSeverity::Type	Severity,
		FName	MessageID,
		const FLiveLinkSubjectKey &	SubjectKey,
		UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write a repeatable message in to the LiveLink log. Will returns a valid TokenizedMessage if a new TokenizedMessage was created. If the info occurred more than once for that SubjectKey, a counter will indicate the number of time it did occurred.

◆ Warning()

template<typename... ArgsType>

static void FLiveLinkLog::Warning	(	UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write an warning in to the LiveLink log.

◆ WarningOnce()

template<typename... ArgsType>

static void FLiveLinkLog::WarningOnce	(	FName	MessageID,
		const FLiveLinkSubjectKey &	SubjectKey,
		UE::Core::TCheckedFormatString< FString::FmtCharType, ArgsType... >	Format,
		ArgsType...	Args
	)

inlinestatic

Write a warning in to the LiveLink log. If the warning occurred more than once for that SubjectKey, a counter will indicate the number of time it did occurred.

Member Data Documentation

◆ Instance

TUniquePtr< FLiveLinkLog > FLiveLinkLog::Instance

staticprotected

The instance that will manage the logging

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

Engine/Source/Runtime/LiveLinkInterface/Public/LiveLinkLog.h
Engine/Source/Runtime/LiveLinkInterface/Private/LiveLinkLog.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~FLiveLinkLog()

Member Function Documentation

◆ CreateTokenizedMessage()

◆ Error()

◆ ErrorOnce()

◆ GetInstance()

◆ GetLogCount()

◆ GetOccurrence()

◆ GetSelectedOccurrence()

◆ Info()

◆ InfoOnce()

◆ LogMessage()

◆ TokenizedMessage()

◆ TokenizedMessageOnce()

◆ Warning()

◆ WarningOnce()

Member Data Documentation

◆ Instance