Range.cs

Go to the documentation of this file.

using System;
using IDSImaging.Peak.Common.Exceptions;
using IDSImaging.Peak.Common.Internal;
using IDSImaging.Peak.Common.Types.Detail;
 
namespace IDSImaging.Peak.Common.Types
{
    namespace Detail
    {
 
        public class RangeT<T> where T : struct, IComparable<T>
        {
            public RangeT(T minimum, T maximum, T increment)
            {
                if (minimum.CompareTo(maximum) > 0)
                {
                    throw new CommonInvalidParameterException(
                        "Maximum value has to be bigger than or equal to the minimum value");
                }
 
                if (Convert.ToDecimal(increment).CompareTo(Convert.ToDecimal(maximum) - Convert.ToDecimal(minimum)) > 0)
                {
                    throw new CommonInvalidParameterException(
                        "The given increment is larger than the total range!");
                }
 
                Minimum = minimum;
                Maximum = maximum;
                Increment = increment;
            }
 
            public T Minimum { get; }
 
            public T Maximum { get; }
 
            public T Increment { get; }
 
            public override bool Equals(object? obj)
            {
                if (obj is null)
                {
                    return false;
                }
 
                if (ReferenceEquals(this, obj))
                {
                    return true;
                }
 
                if (!(obj is RangeT<T> other))
                {
                    return false;
                }
 
                return Equals(other);
            }
 
            protected bool Equals(RangeT<T> other)
            {
                return Minimum.Equals(other.Minimum) && Maximum.Equals(other.Maximum) &&
                       Increment.Equals(other.Increment);
            }
 
            public override int GetHashCode()
            {
                return (Minimum, Maximum, Increment).GetHashCode();
            }
 
            public override string ToString()
            {
                return Formatting.Invariant(
                    $"{GetType().Name}{{ Minimum = {Minimum}, Maximum = {Maximum}, Increment = {Increment} }}");
            }
        }
    }
 
 
    public class Range : RangeT<int>
    {
        public Range(int minimum, int maximum, int increment)
            : base(minimum, maximum, increment)
        {
        }
    }
 
 
    public class RangeU : RangeT<uint>
    {
        public RangeU(uint minimum, uint maximum, uint increment)
            : base(minimum, maximum, increment)
        {
        }
    }
 
 
    public class RangeU8 : RangeT<byte>
    {
        public RangeU8(byte minimum, byte maximum, byte increment)
            : base(minimum, maximum, increment)
        {
        }
    }
 
 
    public class RangeF : RangeT<float>
    {
        public RangeF(float minimum, float maximum, float increment)
            : base(minimum, maximum, increment)
        {
        }
    }
 
 
    public class RangeD : RangeT<double>
    {
        public RangeD(double minimum, double maximum, double increment)
            : base(minimum, maximum, increment)
        {
        }
    }
}