OTX-Runtime for C++  
OpenTestSystem::Otx::Runtime::Api::Custom::ILoggingImplementation Class Referenceabstract

Allows users to implement their own Logging extension. More...

#include <ILoggingImplementation.h>

Public Member Functions

virtual void CloseAll (std::shared_ptr< IRuntimeContext > runtimeContext)=0
 The log file related to the IRuntimeContext should be closed More...
 
virtual void SetLogLevel (std::shared_ptr< IRuntimeContext > runtimeContext, LogLevels level)=0
 Invoked when a SetLogLevel occurs in OTX-Runtime. More...
 
virtual void WriteLog (std::shared_ptr< IRuntimeContext > runtimeContext, std::string writeLogInfo, SeverityLevels level, std::string target, std::string message)=0
 Invoked when a WriteLog occurs in OTX-Runtime. More...
 

Detailed Description

Allows users to implement their own Logging extension.

Member Function Documentation

◆ CloseAll()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ILoggingImplementation::CloseAll ( std::shared_ptr< IRuntimeContext runtimeContext)
pure virtual

The log file related to the IRuntimeContext should be closed

Parameters
runtimeContextThe related runtime context.

◆ SetLogLevel()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ILoggingImplementation::SetLogLevel ( std::shared_ptr< IRuntimeContext runtimeContext,
LogLevels  level 
)
pure virtual

Invoked when a SetLogLevel occurs in OTX-Runtime.

Parameters
runtimeContextThe related runtime context.
levelOne of LogLevels. The LogLevels = {ALL|TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF}.

◆ WriteLog()

virtual void OpenTestSystem::Otx::Runtime::Api::Custom::ILoggingImplementation::WriteLog ( std::shared_ptr< IRuntimeContext runtimeContext,
std::string  writeLogInfo,
SeverityLevels  level,
std::string  target,
std::string  message 
)
pure virtual

Invoked when a WriteLog occurs in OTX-Runtime.

Parameters
runtimeContextThe related runtime context.
writeLogInfoAdditional information consits of Project, Package, Document and Procedure. Format: Project:Package:Document:Procedure.
levelOne of SeverityLevels. The SeverityLevels = {TRACE|DEBUG|INFO|WARN|ERROR|FATAL}.
targetTarget is a file path where the log will be written.
messageMessage will be written to the log file.

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