Log File Setting

Introduction

These functions are responsible for setting the log from a camera.

HelloVizionSDK

Function:

C++

void HelloVizionSDK()

Python

def HelloVizionSDK()

C#

void HelloVizionSDK()

C

void hello_vizionsdk()

Function Description:

• This function is used to get the version of the VizionSDK from the log.

Parameter Description:

• This function does not take any input parameters.

Example:

C++

HelloVizionSDK();
// Hello VizionSDK!
// Version: {VizionSDK Version}

Python

pyvizionsdk.HelloVizionSDK()
# Hello VizionSDK!
# Version: {VizionSDK Version}

C#

CSVizionSDK.HelloVizionSDK();
// Hello VizionSDK!
// Version: {VizionSDK Version}

C

hello_vizionsdk();
// Hello VizionSDK!
// Version: {VizionSDK Version}

VxSetLogFile

Function:

C++

int VxSetLogFile(const std::string& folderPath)

Python

def VxSetLogFile(folderPath)

C#

int VxSetLogFile(string folderPath)

C

int vx_set_log_file(const char* folderPath)

Function Description:

• This function is used to set the destination path where to save the log file.

Parameter Description:

• folderPath : A string constants of folder path.

• Return : return 0 = PASS, return -1 = FAIL.

Example:

C++

const std::string folderPath = "LOG_PATH";
// set the destination path of log file
VxSetLogFile(folderPath);

Python

folderPath = "LOG_PATH"
# set the destination path of log file
pyvizionsdk.VxSetLogFile(folderPath)

C#

string folderPath = "LOG_PATH";
// set the destination path of log file
CSVizionSDK.VxSetLogFile(folderPath);

C

const char* folderPath = "LOG_PATH";
// set the destination path of log file
vx_set_log_file(folderPath);

VxSetLogLevel

Function:

C++

void VxSetLogLevel(VX_LOG_LEVEL level)

Python

def VxSetLogLevel(level)

C#

void VxSetLogLevel(VX_LOG_LEVEL level)

C

void vx_set_log_level(vx_log_level level)

Function Description:

• This function is for setting the log level, determining the verbosity of log messages.

Parameter Description:

• level : The parameter is a VX_LOG_LEVEL variable that represents the level of the log.

  info

  Logging levels follow an order from low to high, meaning that setting a specific level enables logging for that level and all higher severity levels.

• VX_LOG_LEVEL format:

  C++

  // Ordered from Low to High
  enum class VX_LOG_LEVEL {
      VX_LOG_LEVEL_TRACE,
      VX_LOG_LEVEL_DEBUG,
      VX_LOG_LEVEL_INFO,
      VX_LOG_LEVEL_WARN,
      VX_LOG_LEVEL_ERROR,
      VX_LOG_LEVEL_CRITICAL,
      VX_LOG_LEVEL_OFF,
  }

  Python

  # Ordered from Low to High
  class VX_LOG_LEVEL(Enum):    
      VX_LOG_LEVEL_TRACE = 0
      VX_LOG_LEVEL_DEBUG = 1
      VX_LOG_LEVEL_INFO = 2
      VX_LOG_LEVEL_WARN = 3
      VX_LOG_LEVEL_ERROR = 4
      VX_LOG_LEVEL_CRITICAL = 5
      VX_LOG_LEVEL_OFF = 6

  C#

  // Ordered from Low to High
  public enum VX_LOG_LEVEL {
      VX_LOG_LEVEL_TRACE,
      VX_LOG_LEVEL_DEBUG,
      VX_LOG_LEVEL_INFO,
      VX_LOG_LEVEL_WARN,
      VX_LOG_LEVEL_ERROR,
      VX_LOG_LEVEL_CRITICAL,
      VX_LOG_LEVEL_OFF,
  }

  C

  // Ordered from Low to High
  typedef enum vx_log_level {
      VX_LOG_LEVEL_TRACE = 0,
      VX_LOG_LEVEL_DEBUG = 1,
      VX_LOG_LEVEL_INFO = 2,
      VX_LOG_LEVEL_WARN = 3,
      VX_LOG_LEVEL_ERROR = 4,
      VX_LOG_LEVEL_CRITICAL = 5,
      VX_LOG_LEVEL_OFF = 6,
  } vx_log_level;

Example:

C++

// Set the log level to information level
VxSetLogLevel(VX_LOG_LEVEL::VX_LOG_LEVEL_INFO);

Python

from pyvizionsdk import VX_LOG_LEVEL
# Set the log level to information level
pyvinzionsdk.VxSetLogLevel(VX_LOG_LEVEL.VX_LOG_LEVEL_INFO)

C#

// Set the log level to information level
CSVizionSDK.VxSetLogLevel(VX_LOG_LEVEL.VX_LOG_LEVEL_INFO);

C

// Set the log level to information level
vx_set_log_level(VX_LOG_LEVEL_INFO);

Explanation of Levels(Ordered from Low to High):

• VX_LOG_LEVEL_TRACE : Provides the most detailed logging, capturing step-by-step execution flow.
• VX_LOG_LEVEL_DEBUG : Includes debugging information for developers, offering insights into internal operations and variable states.
• VX_LOG_LEVEL_INFO (Default) : Logs general operational events, such as initialization, configuration changes, and so on.
• VX_LOG_LEVEL_WARN : Highlights potential issues that do not immediately impact functionality.
• VX_LOG_LEVEL_ERROR : Captures critical issues that disrupt specific functionalities but do not cause system-wide failure.
• VX_LOG_LEVEL_CRITICAL : Logs severe errors that may lead to system or application failure, requiring urgent attention.
• VX_LOG_LEVEL_OFF : Disables all logging, preventing any messages from being recorded.

VxSetLogCallback

Function:

C++

void VxSetLogCallback(VxLogCallback callback, void* userData)

C

void vx_set_log_callback(vx_log_callback callback, void* userData)

Function Description:

• This function registers a callback to receive SDK log messages. Once set, the callback is invoked for every log message at or above the current log level.

Parameter Description:

• callback : A function pointer matching the VxLogCallback signature:

  C++

  using VxLogCallback = void (*)(VX_LOG_LEVEL level, const char* message, void* userData);

  C

  typedef void (*vx_log_callback)(vx_log_level level, const char* message, void* userData);

• userData : An arbitrary pointer passed back unchanged to the callback on every invocation. Pass NULL / nullptr if not needed.

• Return : This function does not return a value.

Example:

C++

void MyLogHandler(VX_LOG_LEVEL level, const char* message, void* userData) {
    std::cout << "[SDK] " << message << std::endl;
}

// Register the log callback
VxSetLogCallback(MyLogHandler, nullptr);

C

void my_log_handler(vx_log_level level, const char* message, void* userData) {
    printf("[SDK] %s\n", message);
}

/* Register the log callback */
vx_set_log_callback(my_log_handler, NULL);

VxClearLogCallback

Function:

C++

void VxClearLogCallback()

C

void vx_clear_log_callback()

Function Description:

• This function unregisters the currently active log callback. After this call, SDK log messages are no longer forwarded to the previously registered callback.

Parameter Description:

• This function does not take any input parameters.

• Return : This function does not return a value.

Example:

C++

// Unregister the log callback
VxClearLogCallback();

C

/* Unregister the log callback */
vx_clear_log_callback();