IOutput.cs

// Copyright (c) 2025, Phoenix Contact GmbH & Co. KG
// Licensed under the Apache License, Version 2.0

namespace Moryx.AbstractionLayer.Drivers.InOut
{
    /// <summary>
    /// Interface for writing output
    /// </summary>
    public interface IOutput<TOut>
    {
        /// <summary>
        /// Access flags for the output
        /// </summary>
        SupportedAccess Access { get; }

        /// <summary>
        /// Single value output
        /// Only available for <see cref="SupportedAccess.Single"/>
        /// </summary>
        /// <exception cref="DriverStateException">Will be thrown when the driver is in wrong state</exception>
        TOut Value { get; set; }

        /// <summary>
        /// Index based output
        /// Only available for <see cref="SupportedAccess.Index"/>
        /// </summary>
        /// <exception cref="DriverStateException">Will be thrown when the driver is in wrong state</exception>
        TOut this[int index] { get; set; }

        /// <summary>
        /// Key based output
        /// Only available for <see cref="SupportedAccess.Key"/>
        /// </summary>
        /// <exception cref="DriverStateException">Will be thrown when the driver is in wrong state</exception>
        TOut this[string key] { get; set; }
    }
}