documentation

Visometry.VisionLib.SDK.Core.API.Issue Class Reference

This class contains information about an issue raised by the native VisionLib SDK. More...

Public Types

enum  IssueType { Notification = 0, Warning = 1, Error = 2 }
 

Data Fields

MonoBehaviour caller = null
 Origin of the issue. May be null if not mentioned. More...
 
int code
 The unique code for the error More...
 
string commandName
 The name of the command causing this issue. More...
 
string info
 The machine readable info on the error/warning. More...
 
IssueType level
 The error level More...
 
string message
 The english human readable message on the error/warning. More...
 

Detailed Description

This class contains information about an issue raised by the native VisionLib SDK.

Field Documentation

◆ caller

MonoBehaviour Visometry.VisionLib.SDK.Core.API.Issue.caller = null

Origin of the issue. May be null if not mentioned.

◆ code

int Visometry.VisionLib.SDK.Core.API.Issue.code

The unique code for the error

For current error codes see Initialization Issues

◆ commandName

string Visometry.VisionLib.SDK.Core.API.Issue.commandName

The name of the command causing this issue.

◆ info

string Visometry.VisionLib.SDK.Core.API.Issue.info

The machine readable info on the error/warning.

This might be matter of change - but can help to understand the issue Do not rely on the string except that it holds special information like the device name etc..

◆ level

IssueType Visometry.VisionLib.SDK.Core.API.Issue.level

The error level

◆ message

string Visometry.VisionLib.SDK.Core.API.Issue.message

The english human readable message on the error/warning.

This might be matter of change - but can help to understand the issue Do not rely on the string.