bin/projects/dbatools/dbatools/Utility/DbaTimeSpanPretty.cs

using System;
 
namespace Sqlcollaborative.Dbatools.Utility
{
    /// <summary>
    /// Makes timespan great again
    /// </summary>
    public class DbaTimeSpanPretty : DbaTimeSpan
    {
        #region Methods
        /// <summary>
        /// Creates a new, pretty timespan object from milliseconds
        /// </summary>
        /// <param name="Milliseconds">The milliseconds to convert from.</param>
        /// <returns>A pretty timespan object</returns>
        public static DbaTimeSpanPretty FromMilliseconds(double Milliseconds)
        {
            return new DbaTimeSpanPretty((long)(Milliseconds * 10000));
        }
        #endregion Methods
 
        #region Fields
        /// <summary>
        /// The number of digits a pretty timespan should round to.
        /// </summary>
        public int Digits = 2;
        #endregion Fields
 
        #region Constructors
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timespan"></param>
        public DbaTimeSpanPretty(TimeSpan Timespan)
            : base(Timespan)
        {
 
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="ticks"></param>
        public DbaTimeSpanPretty(long ticks)
            : base(ticks)
        {
 
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="hours"></param>
        /// <param name="minutes"></param>
        /// <param name="seconds"></param>
        public DbaTimeSpanPretty(int hours, int minutes, int seconds)
            : base(hours, minutes, seconds)
        {
 
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="days"></param>
        /// <param name="hours"></param>
        /// <param name="minutes"></param>
        /// <param name="seconds"></param>
        public DbaTimeSpanPretty(int days, int hours, int minutes, int seconds)
            : base(days, hours, minutes, seconds)
        {
 
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="days"></param>
        /// <param name="hours"></param>
        /// <param name="minutes"></param>
        /// <param name="seconds"></param>
        /// <param name="milliseconds"></param>
        public DbaTimeSpanPretty(int days, int hours, int minutes, int seconds, int milliseconds)
            : base(days, hours, minutes, seconds, milliseconds)
        {
 
        }
        #endregion Constructors
 
        /// <summary>
        /// Creates extra-nice timespan formats
        /// </summary>
        /// <returns>Humanly readable timespans</returns>
        public override string ToString()
        {
            if (UtilityHost.DisableCustomTimeSpan) { return _timespan.ToString(); }
 
            string temp = "";
 
            if (_timespan.TotalSeconds < 1)
            {
                temp = Math.Round(_timespan.TotalMilliseconds, Digits).ToString() + " ms";
            }
            else if (_timespan.TotalSeconds <= 60)
            {
                temp = Math.Round(_timespan.TotalSeconds, Digits).ToString() + " s";
            }
            else
            {
                if (_timespan.Ticks % 10000000 == 0) { return _timespan.ToString(); }
                else
                {
                    temp = _timespan.ToString();
 
                    temp = temp.Substring(0, temp.LastIndexOf("."));
 
                    return temp;
                }
            }
 
            return temp;
        }
    }
}