Contains the Logging settings. More...

#include <ILoggingSettings.h>

Public Member Functions
virtual std::string	GetDirectory ()=0
	Gets the directory name. More...

virtual std::string	GetFileName ()=0
	Gets the file name. More...

virtual int	GetFileSize ()=0
	Gets the max file size [MB]. More...

virtual std::string	GetHeaderFormat ()=0
	Gets the header format. More...

virtual bool	GetLogCommunicationTrace ()=0
	Checks the communication trace should be logged or not. Default value: FALSE. More...

virtual SeverityLevels	GetLogCommunicationTraceSeverityLevel ()=0
	Gets the severity level of Variables Communication logging. Default value: TRACE. More...

virtual TraceLevels	GetLoggingLevelDefault ()=0
	Gets default log level of the OTX-Runtime. Default value: "ALL". More...

virtual bool	GetLoggingOn ()=0
	Gets the logging status. Default value: TRUE. More...

virtual bool	GetLoggingTargetResolving ()=0
	If a PTX is exported, empty target properties of the WriteLog-Activity be filled with default values or not More...

virtual bool	GetLogOtxException ()=0
	Checks the exceptions should be logged or not. Default value: FALSE. More...

virtual SeverityLevels	GetLogOtxExceptionSeverityLevel ()=0
	Gets the severity level of Exception logging. Default value: TRACE. More...

virtual bool	GetLogVariableTrace ()=0
	Checks the variable trace should be logged or not. Default value: FALSE. More...

virtual SeverityLevels	GetLogVariableTraceSeverityLevel ()=0
	Gets the severity level of Variables Trace logging. Default value: TRACE. More...

virtual int	GetMaxFileNumber ()=0
	Gets the max file number. More...

virtual std::string	GetMessageFormat ()=0
	Gets the message format. More...

virtual bool	GetWriteId ()=0
	Checks the OTX-IDs should be logged or not. Default value: FALSE. More...

virtual SeverityLevels	GetWriteIdSeverityLevel ()=0
	Gets the severity level of Otx-Id logging. Default value: TRACE. More...

virtual void	SetDirectory (const std::string &value)=0
	Sets the directory name. More...

virtual void	SetFileName (const std::string &value)=0
	Sets the file name. More...

virtual void	SetFileSize (int value)=0
	Sets the max file size [MB]. More...

virtual void	SetHeaderFormat (const std::string &value)=0
	Sets the header format. More...

virtual void	SetLogCommunicationTrace (bool value)=0
	Sets the communication trace should be logged or not. Default value: FALSE. More...

virtual void	SetLogCommunicationTraceSeverityLevel (SeverityLevels value)=0
	Sets the severity level of Variables Communication logging. Default value: TRACE. More...

virtual void	SetLoggingLevelDefault (TraceLevels value)=0
	Sets default log level of the OTX-Runtime. Default value: "ALL". More...

virtual void	SetLoggingOn (bool value)=0
	Sets the logging status. Default value: TRUE. More...

virtual void	SetLoggingTargetResolving (bool value)=0
	If a PTX is exported, empty target properties of the WriteLog-Activity be filled with default values or not More...

virtual void	SetLogOtxException (bool value)=0
	Sets the exceptions should be logged or not. Default value: FALSE. More...

virtual void	SetLogOtxExceptionSeverityLevel (SeverityLevels value)=0
	Sets the severity level of Exception logging. Default value: TRACE. More...

virtual void	SetLogVariableTrace (bool value)=0
	Sets the variable trace should be logged or not. Default value: FALSE. More...

virtual void	SetLogVariableTraceSeverityLevel (SeverityLevels value)=0
	Sets the severity level of Variables Trace logging. Default value: TRACE. More...

virtual void	SetMaxFileNumber (int value)=0
	Sets the max file number. More...

virtual void	SetMessageFormat (const std::string &value)=0
	Sets the message format. More...

virtual void	SetWriteId (bool value)=0
	Sets the OTX-IDs should be logged or not. Default value: FALSE. More...

virtual void	SetWriteIdSeverityLevel (SeverityLevels value)=0
	Sets the severity level of Otx-Id logging. Default value: TRACE. More...

Detailed Description

Contains the Logging settings.

Member Function Documentation

◆ GetDirectory()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetDirectory ( )

pure virtual

Gets the directory name.

Returns: Directory name

◆ GetFileName()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetFileName ( )

pure virtual

Gets the file name.

Returns: File name

◆ GetFileSize()

virtual int OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetFileSize ( )

pure virtual

Gets the max file size [MB].

Returns: Max file size [MB]

◆ GetHeaderFormat()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetHeaderFormat ( )

pure virtual

Gets the header format.

Returns: Header format

◆ GetLogCommunicationTrace()

virtual bool OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLogCommunicationTrace ( )

pure virtual

Checks the communication trace should be logged or not. Default value: FALSE.

Returns: bool

◆ GetLogCommunicationTraceSeverityLevel()

virtual SeverityLevels OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLogCommunicationTraceSeverityLevel ( )

pure virtual

Gets the severity level of Variables Communication logging. Default value: TRACE.

Returns: SeverityLevels

◆ GetLoggingLevelDefault()

virtual TraceLevels OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLoggingLevelDefault ( )

pure virtual

Gets default log level of the OTX-Runtime. Default value: "ALL".

Returns: TraceLevels

◆ GetLoggingOn()

virtual bool OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLoggingOn ( )

pure virtual

Gets the logging status. Default value: TRUE.

Returns: bool

◆ GetLoggingTargetResolving()

virtual bool OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLoggingTargetResolving ( )

pure virtual

If a PTX is exported, empty target properties of the WriteLog-Activity be filled with default values or not

Returns: bool

◆ GetLogOtxException()

virtual bool OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLogOtxException ( )

pure virtual

Checks the exceptions should be logged or not. Default value: FALSE.

Returns: bool

◆ GetLogOtxExceptionSeverityLevel()

virtual SeverityLevels OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLogOtxExceptionSeverityLevel ( )

pure virtual

Gets the severity level of Exception logging. Default value: TRACE.

Returns: SeverityLevels

◆ GetLogVariableTrace()

virtual bool OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLogVariableTrace ( )

pure virtual

Checks the variable trace should be logged or not. Default value: FALSE.

Returns: bool

◆ GetLogVariableTraceSeverityLevel()

virtual SeverityLevels OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetLogVariableTraceSeverityLevel ( )

pure virtual

Gets the severity level of Variables Trace logging. Default value: TRACE.

Returns: SeverityLevels

◆ GetMaxFileNumber()

virtual int OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetMaxFileNumber ( )

pure virtual

Gets the max file number.

Returns: Max file number

◆ GetMessageFormat()

virtual std::string OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetMessageFormat ( )

pure virtual

Gets the message format.

Returns: Message format

◆ GetWriteId()

virtual bool OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetWriteId ( )

pure virtual

Checks the OTX-IDs should be logged or not. Default value: FALSE.

Returns: bool

◆ GetWriteIdSeverityLevel()

virtual SeverityLevels OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::GetWriteIdSeverityLevel ( )

pure virtual

Gets the severity level of Otx-Id logging. Default value: TRACE.

Returns: SeverityLevels

◆ SetDirectory()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetDirectory ( const std::string & value )

pure virtual

Sets the directory name.

A new directory name

◆ SetFileName()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetFileName ( const std::string & value )

pure virtual

Sets the file name.

A new file name

◆ SetFileSize()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetFileSize ( int value )

pure virtual

Sets the max file size [MB].

A new max file size [MB]

◆ SetHeaderFormat()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetHeaderFormat ( const std::string & value )

pure virtual

Sets the header format.

A new header format

◆ SetLogCommunicationTrace()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLogCommunicationTrace ( bool value )

pure virtual

Sets the communication trace should be logged or not. Default value: FALSE.

The value

◆ SetLogCommunicationTraceSeverityLevel()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLogCommunicationTraceSeverityLevel ( SeverityLevels value )

pure virtual

Sets the severity level of Variables Communication logging. Default value: TRACE.

The SeverityLevels

◆ SetLoggingLevelDefault()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLoggingLevelDefault ( TraceLevels value )

pure virtual

Sets default log level of the OTX-Runtime. Default value: "ALL".

The TraceLevels

◆ SetLoggingOn()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLoggingOn ( bool value )

pure virtual

Sets the logging status. Default value: TRUE.

The value

◆ SetLoggingTargetResolving()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLoggingTargetResolving ( bool value )

pure virtual

If a PTX is exported, empty target properties of the WriteLog-Activity be filled with default values or not

The value

◆ SetLogOtxException()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLogOtxException ( bool value )

pure virtual

Sets the exceptions should be logged or not. Default value: FALSE.

The value

◆ SetLogOtxExceptionSeverityLevel()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLogOtxExceptionSeverityLevel ( SeverityLevels value )

pure virtual

Sets the severity level of Exception logging. Default value: TRACE.

The SeverityLevels

◆ SetLogVariableTrace()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLogVariableTrace ( bool value )

pure virtual

Sets the variable trace should be logged or not. Default value: FALSE.

The value

◆ SetLogVariableTraceSeverityLevel()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetLogVariableTraceSeverityLevel ( SeverityLevels value )

pure virtual

Sets the severity level of Variables Trace logging. Default value: TRACE.

The SeverityLevels

◆ SetMaxFileNumber()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetMaxFileNumber ( int value )

pure virtual

Sets the max file number.

A new max file number

◆ SetMessageFormat()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetMessageFormat ( const std::string & value )

pure virtual

Sets the message format.

A new message format

◆ SetWriteId()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetWriteId ( bool value )

pure virtual

Sets the OTX-IDs should be logged or not. Default value: FALSE.

Checks or sets the OTX-IDs should be logged or not. Default value: FALSE. Together with the OTX-ID the following profiling information will be written:

OTX-ID of the to be executed activity
Time stamp in nano seconds
Thread-ID
Used virtual process memory in bytes
Used physical process memory in bytes
CPU load of process in percent
Used virtual system memory in bytes
Used physical system memory in bytes
CPU load of system in percent

Note: The profiling can be analysed with the OTX Profiler inside the Open Test Framework.

The value

◆ SetWriteIdSeverityLevel()

virtual void OpenTestSystem::Otx::Runtime::Api::Project::Settings::ILoggingSettings::SetWriteIdSeverityLevel ( SeverityLevels value )

pure virtual

Sets the severity level of Otx-Id logging. Default value: TRACE.

The SeverityLevels

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

ILoggingSettings.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetDirectory()

◆ GetFileName()

◆ GetFileSize()

◆ GetHeaderFormat()

◆ GetLogCommunicationTrace()

◆ GetLogCommunicationTraceSeverityLevel()

◆ GetLoggingLevelDefault()

◆ GetLoggingOn()

◆ GetLoggingTargetResolving()

◆ GetLogOtxException()

◆ GetLogOtxExceptionSeverityLevel()

◆ GetLogVariableTrace()

◆ GetLogVariableTraceSeverityLevel()

◆ GetMaxFileNumber()

◆ GetMessageFormat()

◆ GetWriteId()

◆ GetWriteIdSeverityLevel()

◆ SetDirectory()

◆ SetFileName()

◆ SetFileSize()

◆ SetHeaderFormat()

◆ SetLogCommunicationTrace()

◆ SetLogCommunicationTraceSeverityLevel()

◆ SetLoggingLevelDefault()

◆ SetLoggingOn()

◆ SetLoggingTargetResolving()

◆ SetLogOtxException()

◆ SetLogOtxExceptionSeverityLevel()

◆ SetLogVariableTrace()

◆ SetLogVariableTraceSeverityLevel()

◆ SetMaxFileNumber()

◆ SetMessageFormat()

◆ SetWriteId()

◆ SetWriteIdSeverityLevel()