ModuleBase.cs

Go to the documentation of this file.

using IDSImaging.Peak.Common.Pipeline.Modules;
using IDSImaging.Peak.Common.Serialization;
using IDSImaging.Peak.ICV.Types;
 
namespace IDSImaging.Peak.ICV.Pipeline.Modules;
 
public abstract class ModuleBase : IModule
{
    internal const string VersionKey = "Version";
    internal const string EnabledKey = "Enabled";
 
    public int Version { get; protected set; } = 1;
 
    public virtual bool IsEnabled { get; set; } = true;
 
    public abstract string TypeId { get; }
 
    public virtual void Serialize(IArchive archive)
    {
        archive.SetBool(EnabledKey, IsEnabled);
        archive.SetInt64(VersionKey, Version);
    }
 
    public virtual void Deserialize(IArchive archive)
    {
        var version = archive.GetInt64(VersionKey);
        ValidateVersion(version, TypeId);
        IsEnabled = archive.GetBool(EnabledKey);
    }
 
    public virtual object Process(object input)
    {
        if (input is not Image image)
        {
            throw new IcvNotSupportedException(
                $"Casting from {input.GetType().Name} to the given type {typeof(Image).Name} is not supported!");
        }
 
        return Process(image);
    }
 
    public virtual void ResetToDefault()
    {
    }
 
    public abstract Image Process(Image inputImage);
 
    internal void ValidateVersion(long version, string moduleName)
    {
        if (version < 1)
        {
            throw new IcvNotSupportedException(
                $"The 'Version' entry {version} int the archive for " +
                $"module {moduleName} is invalid! Must be at least 1.");
        }
    }
}