Exception.cs

Go to the documentation of this file.

using System.Runtime.InteropServices;
using System.Runtime.Serialization;
using IDSImaging.Peak.Common.Exceptions;
using IDSImaging.Peak.ICV.Backend;
 
namespace IDSImaging.Peak.ICV;
 
[Serializable]
public class IcvException : CommonException
{
    internal IcvException(string message, Backend.Types.peak_icv_status errorCode)
        : base(message)
    {
        ErrorCode = errorCode;
    }
 
    internal IcvException(SerializationInfo info, StreamingContext context)
        : base(info, context)
    {
        ErrorCode = (Backend.Types.peak_icv_status)
            info.GetValue(nameof(ErrorCode), typeof(Backend.Types.peak_icv_status));
    }
 
    internal Backend.Types.peak_icv_status ErrorCode { get; }
 
    public override string Message => $"{base.Message} - ErrorCode: {ErrorCode}";
 
    public override void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        base.GetObjectData(info, context);
        info.AddValue(nameof(ErrorCode), ErrorCode);
    }
}
 
public class IcvInvalidConfigurationException : IcvException
{
    internal IcvInvalidConfigurationException(string message, Backend.Types.peak_icv_status errorCode)
        : base(message, errorCode)
    {
    }
}
 
public class IcvNotSupportedException : IcvException, ICommonNotSupportedException
{
    internal IcvNotSupportedException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_NOT_SUPPORTED)
    {
    }
}
 
public class IcvCorruptedException : IcvException
{
    internal IcvCorruptedException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_CORRUPTED)
    {
    }
}
 
public class IcvMismatchException : IcvException
{
    internal IcvMismatchException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_MISMATCH)
    {
    }
}
 
public class IcvNotPossibleException : IcvException
{
    internal IcvNotPossibleException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_NOT_POSSIBLE)
    {
    }
}
 
public class IcvNullPointerException : IcvException
{
    internal IcvNullPointerException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_NULL_POINTER)
    {
    }
}
 
public class IcvOutOfRangeException : IcvException, ICommonOutOfRangeException
{
    internal IcvOutOfRangeException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_OUT_OF_RANGE)
    {
    }
}
 
public class IcvMathErrorException : IcvException
{
    internal IcvMathErrorException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_MATH_ERROR)
    {
    }
}
 
public class IcvTargetNotFoundException : IcvException
{
    internal IcvTargetNotFoundException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_TARGET_NOT_FOUND)
    {
    }
}
 
public class IcvIOException : IcvException, ICommonIOException
{
    internal IcvIOException(string message)
        : base(message, Backend.Types.peak_icv_status.PEAK_ICV_STATUS_IO_ERROR)
    {
    }
}
 
public class IcvInternalErrorException : IcvException, ICommonInternalErrorException
{
    internal IcvInternalErrorException(string message, Backend.Types.peak_icv_status errorCode)
        : base(message, errorCode)
    {
    }
}
 
internal static class DllHelper
{
    public static void ExecuteAndMapReturnCodes(Func<Backend.Types.peak_icv_status> dllFunction)
    {
        Backend.Types.peak_icv_status errorCode = dllFunction();
        if (errorCode == Backend.Types.peak_icv_status.PEAK_ICV_STATUS_SUCCESS)
        {
            return;
        }
 
        var errorText = GetLastError();
        switch (errorCode)
        {
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_LIBRARY_NOT_INITIALIZED:
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_DYNAMIC_DEPENDENCY_MISSING:
                throw new IcvInvalidConfigurationException(errorText, errorCode);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_MISMATCH:
                throw new IcvMismatchException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_NOT_SUPPORTED:
                throw new IcvNotSupportedException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_NOT_POSSIBLE:
                throw new IcvNotPossibleException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_NULL_POINTER:
                throw new IcvNullPointerException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_OUT_OF_RANGE:
                throw new IcvOutOfRangeException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_MATH_ERROR:
                throw new IcvMathErrorException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_TARGET_NOT_FOUND:
                throw new IcvTargetNotFoundException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_CORRUPTED:
                throw new IcvCorruptedException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_IO_ERROR:
                throw new IcvIOException(errorText);
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_INTERNAL_ERROR:
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_INVALID_BUFFER_SIZE:
            case Backend.Types.peak_icv_status.PEAK_ICV_STATUS_INVALID_HANDLE:
                throw new IcvInternalErrorException(errorText, errorCode);
 
            default:
                throw new IcvException("Generic Error!", errorCode);
        }
    }
 
    public static void ExecuteAndMapReturnCodesLight(Func<Backend.Types.peak_icv_status> dllFunction)
    {
        Backend.Types.peak_icv_status errorCode = dllFunction();
        if (errorCode == Backend.Types.peak_icv_status.PEAK_ICV_STATUS_SUCCESS)
        {
            return;
        }
 
        throw new IcvException("Could not query the last error!", errorCode);
    }
 
    internal static string GetLastError()
    {
        var count = (nuint) 0u;
        ExecuteAndMapReturnCodesLight(() => CInterface.peak_icv_GetLastErrorMessage_GetCount(out count));
        var buffer = new byte[(int) count];
        ExecuteAndMapReturnCodesLight(() => CInterface.peak_icv_GetLastErrorMessage(buffer, count));
        return Utils.FromUtf8(buffer);
    }
 
    private static class CInterface
    {
        [DllImport(Global.LibraryName, CallingConvention = Global.CallingConvention)]
        public static extern Backend.Types.peak_icv_status peak_icv_GetLastErrorMessage_GetCount(out nuint count);
 
        [DllImport(Global.LibraryName, CallingConvention = Global.CallingConvention)]
        public static extern Backend.Types.peak_icv_status peak_icv_GetLastErrorMessage(
            byte[] lastErrorMessage,
            nuint count);
    }
}