MonetaryUnit.cs

Go to the documentation of this file.

using System;
using System.Runtime.Serialization;
using AnalyzeRe.Attributes;
 
// ReSharper disable once CheckNamespace (Type is common enough to be on root namespace)
// ReSharper disable NonReadonlyMemberInGetHashCode
// We only compute the hashCode the first time it's needed, then never modify it.
// Furthermore, the properties of a monetary unit never be changed after initialization,
// they're only modifiable for deserialization purposes.
namespace AnalyzeRe
{
    public class MonetaryUnit : APIType, IEquatable<MonetaryUnit>
    {
        #region Private Properties
        private int? _hashCode;
 
        // Backing fields for public properties
        private string _currency;
        private double _value;
        private DateTime? _valueDate;
        private double? _rate;
        private string _rateCurrency;
        #endregion Private Properties
 
        #region Properties
        [DataMember(Order = 2)]
        [NotNull]
        [NotEmpty]
        public string currency
        {
            get => _currency;
            set
            {
                _currency = value;
                _hashCode = null;
            }
        }
 
        [DataMember(Order = 3)]
        public double value
        {
            get => _value;
            set
            {
                _value = value;
                _hashCode = null;
            }
        }
 
        [DataMember(Order = 4)]
        public DateTime? value_date
        {
            get => _valueDate;
            set
            {
                _valueDate = value;
                _hashCode = null;
            }
        }
 
        [DataMember(Order = 5)]
        [GreaterThan(0, canEqual: true)]
        public double? rate
        {
            get => _rate;
            set
            {
                _rate = value;
                _hashCode = null;
            }
        }
 
        [DataMember(Order = 6)]
        [NotEmpty]
        public string rate_currency
        {
            get => _rateCurrency;
            set
            {
                _rateCurrency = value;
                _hashCode = null;
            }
        }
        #endregion Properties
 
        #region Constructors
        [Obsolete("Constructor only exists temporarily for the deserializer. All monetary units " +
            "should be created using one of the other constructors.")]
        public MonetaryUnit()
        {
        }
 
        public MonetaryUnit(double value, string currency)
        {
            _currency = currency;
            _value = value;
        }
 
        public MonetaryUnit(double value, string currency, DateTime value_date)
            : this(value, currency)
        {
            _valueDate = value_date;
        }
 
        public MonetaryUnit(double value, string currency, double rate, string rate_currency)
            : this(value, currency)
        {
            _rate = rate;
            _rateCurrency = rate_currency;
        }
        #endregion Constructors
 
        #region Object Overrides
        public override string ToString()
        {
            double absValue = Math.Abs(value);
            string strRepresentation = 1E18 >= absValue && absValue >= 1000 ?
                value.ToString("N2") : value.ToString("G");
            if (currency != null)
                strRepresentation = $"{currency} {strRepresentation}";
            if (value_date != null)
                // "o" is a DateTime round-trip representation which preserves the original time zone.
                strRepresentation += " FX rate fixed to " + value_date.Value.ToString("o");
            if (_rate != null)
                strRepresentation += $" FX rate fixed to {rate_currency} {_rate.Value:G}";
            return strRepresentation;
        }
 
        public bool Equals(MonetaryUnit other) => ReferenceEquals(this, other) ||
            other != null &&
            Equals(_currency, other.currency) &&
            Equals(_value, other.value) &&
            Equals(_valueDate, other.value_date) &&
            Equals(_rate, other.rate) &&
            Equals(_rateCurrency, other.rate_currency);
 
        public override bool Equals(object obj) =>
            obj is MonetaryUnit objMonetaryUnit && Equals(objMonetaryUnit);
 
        public override int GetHashCode()
        {
            if (!_hashCode.HasValue)
                _hashCode = new { _currency, _value, _valueDate, _rate, _rateCurrency }.GetHashCode();
            return _hashCode.Value;
        }
        #endregion Object Overrides
    }
}