TimeOfDay Class for C#
By
Steve on
Friday, May 31, 2019
Viewed
16,269 times. (
3 times today.)
The DateTime class in the .NET framework has a TimeOfDay property which returns a TimeSpan object.
That's a decent first approximation, but using a TimeSpan for the time of day has many drawbacks. Aside from being inconvenient, it also won't properly account for Daylight Savings Time.
The following TimeOfDay class is a wrapper around DateTime functionality. It fully leverages all of the intelligence already embedded in the DateTime class. As such, it's a much better approach to handling time of day than a simple TimeSpan.
Usage
Let's begin with several examples of how to use the TimeOfDay class. The full class file can be found at the bottom of this post.
Instantiation:
// The default constructor represents midnight
TimeOfDay td = new TimeOfDay();
Assert.AreEqual(0, td.Hour);
Assert.AreEqual(0, td.Minute);
Assert.AreEqual(0, td.Second);
// The standard constructor takes an hour (0-23), minute (0-59) and second (0-59)
TimeOfDay td = new TimeOfDay(23, 59, 59);
Assert.AreEqual(23, td.Hour);
Assert.AreEqual(59, td.Minute);
Assert.AreEqual(59, td.Second);
// You can instantiate with a DateTime.
TimeOfDay td = new TimeOfDay(DateTime.Now);
// Or with another TimeOfDay object.
TimeOfDay td = new TimeOfDay(TimeOfDay.Parse("15:32:17"));
// You can also use an HHmmss format which is a 5 or 6 digit integer where
// the one or two digit hour is followed by the two digit minute followed by
// the two digit second.
td = new TimeOfDay(235959);
Assert.AreEqual(23, td.Hour);
Assert.AreEqual(59, td.Minute);
Assert.AreEqual(59, td.Second);
td = new TimeOfDay(95959);
Assert.AreEqual(9, td.Hour);
Assert.AreEqual(59, td.Minute);
Assert.AreEqual(59, td.Second);
You Can Add and Subtract
// Adding and subtracting is exactly what you'd expect as long
// as you don't cross a day boundary. For example, what
// happens when you add 23:00 and 5:00. The result is not 28:00,
// but 4:00. You rollover the day boundary and into the next day.
// The TimeOfDay class only cares about time of day, not about
// duration or which day it falls on.
var td = new TimeOfDay(0, 0, 0) + new TimeOfDay(1, 0, 0);
Assert.AreEqual(1, td.Hour);
Assert.AreEqual(0, td.Minute);
td = new TimeOfDay(23, 0) + new TimeOfDay(23, 0, 17);
Assert.AreEqual(22, td.Hour);
Assert.AreEqual(0, td.Minute);
Assert.AreEqual(17, td.Second);
td = new TimeOfDay(23, 59, 59) - new TimeOfDay(23, 59, 59);
Assert.AreEqual(0, td.Hour);
Assert.AreEqual(0, td.Minute);
Assert.AreEqual(0, td.Second);
td = new TimeOfDay(23, 0) - new TimeOfDay(1, 0);
Assert.AreEqual(22, td.Hour);
Assert.AreEqual(0, td.Minute);
Assert.AreEqual(0, td.Second);
td = new TimeOfDay(1, 1, 1) - new TimeOfDay(1, 1, 2);
Assert.AreEqual(23, td.Hour);
Assert.AreEqual(59, td.Minute);
Assert.AreEqual(59, td.Second);
You Can Also Do Comparisons
// Compare TimeOfDay with another TimeOfDay
Assert.IsTrue(new TimeOfDay(0, 0, 0) == new TimeOfDay(0, 0, 0));
Assert.IsTrue(new TimeOfDay(0, 0, 0) != new TimeOfDay(1, 0, 0));
Assert.IsTrue(new TimeOfDay(0, 0, 0) < new TimeOfDay(23, 59, 59));
Assert.IsTrue(new TimeOfDay(0, 0, 1) > new TimeOfDay(0, 0, 0));
Assert.IsTrue(new TimeOfDay(0, 0, 0) <= new TimeOfDay(0, 0, 0));
Assert.IsTrue(new TimeOfDay(0, 0, 0) <= new TimeOfDay(0, 0, 1));
Assert.IsTrue(new TimeOfDay(0, 0, 0) >= new TimeOfDay(0, 0, 0));
Assert.IsTrue(new TimeOfDay(1, 5, 17) >= new TimeOfDay(1, 5, 16));
Assert.IsTrue(new TimeOfDay(1, 0, 0) >= new TimeOfDay(0, 0, 59));
// Compare TimeOfDay with a DateTime. Note that we're only
// comparing the time of day portion of the DateTime.
DateTime dt = DateTime.Parse("1/1/2017 14:21:03");
TimeOfDay tod = new TimeOfDay(14, 21, 3);
Assert.IsTrue(tod == dt);
Assert.IsTrue(dt == tod);
dt = DateTime.Parse("1/1/2017 14:21");
tod = new TimeOfDay(18, 0);
Assert.IsTrue(tod > dt);
Assert.IsTrue(dt < tod);
Assert.IsTrue(tod >= dt);
Assert.IsTrue(dt <= tod);
// etc.
Parsing text to TimeOfDay
// Text should be in a form like:
// HH:mm:ss
// H:mm:ss
// HH:mm
// H:mm
//
// Valid examples:
// 14:21:17 (2pm 21min 17sec)
// 02:15 (2am 15min 0sec)
// 2:15 (2am 15min 0sec)
// 2/1/2017 14:21 (2pm 21min 0sec)
// TimeOfDay=15:13:12 (3pm 13min 12sec)
Assert.AreEqual(new TimeOfDay(15, 23, 59), TimeOfDay.Parse("15:23:59"));
Assert.AreEqual(new TimeOfDay(15, 23), TimeOfDay.Parse("15:23"));
Assert.AreEqual(new TimeOfDay(5, 23, 59), TimeOfDay.Parse("5:23:59"));
Assert.AreEqual(new TimeOfDay(15, 23, 59), TimeOfDay.Parse(" 15:23:59 "));
Assert.AreEqual(new TimeOfDay(15, 23, 59), TimeOfDay.Parse("///15:23:59///"));
Assert.AreEqual(new TimeOfDay(15, 23, 59), TimeOfDay.Parse("The time of day is 15:23:59"));
Assert.AreEqual(new TimeOfDay(15, 23, 59), TimeOfDay.Parse("Time of day is 15:23:59, but it will soon be 15:24"));
Assert.AreEqual(new TimeOfDay(0, 23, 0), TimeOfDay.Parse("0:23"));
Assert.AreEqual(new TimeOfDay(0, 0, 0), TimeOfDay.Parse("0:00:00"));
Additional Functionality
There are several more helpful features which I'm sure you can figure out on your own.
- TotalDays (which will always be less than one)
- TotalHours, TotalMinutes, TotalSeconds
- ToDateTime
- ToTimeSpan
- ToToday
- TimeOfDay.Midnight
- TimeOfDay.Noon
Full Source for TimeOfDay Class
TimeOfDay C# Class
// Author: Steve Lautenschlager, CambiaResearch.com
// License: MIT
using System;
using System.Text.RegularExpressions;
namespace Cambia
{
public class TimeOfDay
{
private const int MINUTES_PER_DAY = 60 * 24;
private const int SECONDS_PER_DAY = SECONDS_PER_HOUR * 24;
private const int SECONDS_PER_HOUR = 3600;
private static Regex _TodRegex = new Regex(@"\d?\d:\d\d:\d\d|\d?\d:\d\d");
public TimeOfDay()
{
Init(0, 0, 0);
}
public TimeOfDay(int hour, int minute, int second = 0)
{
Init(hour, minute, second);
}
public TimeOfDay(int hhmmss)
{
Init(hhmmss);
}
public TimeOfDay(DateTime dt)
{
Init(dt);
}
public TimeOfDay(TimeOfDay td)
{
Init(td.Hour, td.Minute, td.Second);
}
public int HHMMSS
{
get
{
return Hour * 10000 + Minute * 100 + Second;
}
}
public int Hour { get; private set; }
public int Minute { get; private set; }
public int Second { get; private set; }
public double TotalDays
{
get
{
return TotalSeconds / (24d * SECONDS_PER_HOUR);
}
}
public double TotalHours
{
get
{
return TotalSeconds / (1d * SECONDS_PER_HOUR);
}
}
public double TotalMinutes
{
get
{
return TotalSeconds / 60d;
}
}
public int TotalSeconds
{
get
{
return Hour * 3600 + Minute * 60 + Second;
}
}
public bool Equals(TimeOfDay other)
{
if (other == null) { return false; }
return TotalSeconds == other.TotalSeconds;
}
public override bool Equals(object obj)
{
if (obj == null) { return false; }
TimeOfDay td = obj as TimeOfDay;
if (td == null) { return false; }
else { return Equals(td); }
}
public override int GetHashCode()
{
return TotalSeconds;
}
public DateTime ToDateTime(DateTime dt)
{
return new DateTime(dt.Year, dt.Month, dt.Day, Hour, Minute, Second);
}
public override string ToString()
{
return ToString("HH:mm:ss");
}
public string ToString(string format)
{
DateTime now = DateTime.Now;
DateTime dt = new DateTime(now.Year, now.Month, now.Day, Hour, Minute, Second);
return dt.ToString(format);
}
public TimeSpan ToTimeSpan()
{
return new TimeSpan(Hour, Minute, Second);
}
public DateTime ToToday()
{
var now = DateTime.Now;
return new DateTime(now.Year, now.Month, now.Day, Hour, Minute, Second);
}
#region -- Static --
public static TimeOfDay Midnight { get { return new TimeOfDay(0, 0, 0); } }
public static TimeOfDay Noon { get { return new TimeOfDay(12, 0, 0); } }
public static TimeOfDay operator -(TimeOfDay t1, TimeOfDay t2)
{
DateTime now = DateTime.Now;
DateTime dt1 = new DateTime(now.Year, now.Month, now.Day, t1.Hour, t1.Minute, t1.Second);
TimeSpan ts = new TimeSpan(t2.Hour, t2.Minute, t2.Second);
DateTime dt2 = dt1 - ts;
return new TimeOfDay(dt2);
}
public static bool operator !=(TimeOfDay t1, TimeOfDay t2)
{
if (ReferenceEquals(t1, t2)) { return true; }
else if (ReferenceEquals(t1, null)) { return true; }
else
{
return t1.TotalSeconds != t2.TotalSeconds;
}
}
public static bool operator !=(TimeOfDay t1, DateTime dt2)
{
if (ReferenceEquals(t1, null)) { return false; }
DateTime dt1 = new DateTime(dt2.Year, dt2.Month, dt2.Day, t1.Hour, t1.Minute, t1.Second);
return dt1 != dt2;
}
public static bool operator !=(DateTime dt1, TimeOfDay t2)
{
if (ReferenceEquals(t2, null)) { return false; }
DateTime dt2 = new DateTime(dt1.Year, dt1.Month, dt1.Day, t2.Hour, t2.Minute, t2.Second);
return dt1 != dt2;
}
public static TimeOfDay operator +(TimeOfDay t1, TimeOfDay t2)
{
DateTime now = DateTime.Now;
DateTime dt1 = new DateTime(now.Year, now.Month, now.Day, t1.Hour, t1.Minute, t1.Second);
TimeSpan ts = new TimeSpan(t2.Hour, t2.Minute, t2.Second);
DateTime dt2 = dt1 + ts;
return new TimeOfDay(dt2);
}
public static bool operator <(TimeOfDay t1, TimeOfDay t2)
{
if (ReferenceEquals(t1, t2)) { return true; }
else if (ReferenceEquals(t1, null)) { return true; }
else
{
return t1.TotalSeconds < t2.TotalSeconds;
}
}
public static bool operator <(TimeOfDay t1, DateTime dt2)
{
if (ReferenceEquals(t1, null)) { return false; }
DateTime dt1 = new DateTime(dt2.Year, dt2.Month, dt2.Day, t1.Hour, t1.Minute, t1.Second);
return dt1 < dt2;
}
public static bool operator <(DateTime dt1, TimeOfDay t2)
{
if (ReferenceEquals(t2, null)) { return false; }
DateTime dt2 = new DateTime(dt1.Year, dt1.Month, dt1.Day, t2.Hour, t2.Minute, t2.Second);
return dt1 < dt2;
}
public static bool operator <=(TimeOfDay t1, TimeOfDay t2)
{
if (ReferenceEquals(t1, t2)) { return true; }
else if (ReferenceEquals(t1, null)) { return true; }
else
{
if (t1 == t2) { return true; }
return t1.TotalSeconds <= t2.TotalSeconds;
}
}
public static bool operator <=(TimeOfDay t1, DateTime dt2)
{
if (ReferenceEquals(t1, null)) { return false; }
DateTime dt1 = new DateTime(dt2.Year, dt2.Month, dt2.Day, t1.Hour, t1.Minute, t1.Second);
return dt1 <= dt2;
}
public static bool operator <=(DateTime dt1, TimeOfDay t2)
{
if (ReferenceEquals(t2, null)) { return false; }
DateTime dt2 = new DateTime(dt1.Year, dt1.Month, dt1.Day, t2.Hour, t2.Minute, t2.Second);
return dt1 <= dt2;
}
public static bool operator ==(TimeOfDay t1, TimeOfDay t2)
{
if (ReferenceEquals(t1, t2)) { return true; }
else if (ReferenceEquals(t1, null)) { return true; }
else { return t1.Equals(t2); }
}
public static bool operator ==(TimeOfDay t1, DateTime dt2)
{
if (ReferenceEquals(t1, null)) { return false; }
DateTime dt1 = new DateTime(dt2.Year, dt2.Month, dt2.Day, t1.Hour, t1.Minute, t1.Second);
return dt1 == dt2;
}
public static bool operator ==(DateTime dt1, TimeOfDay t2)
{
if (ReferenceEquals(t2, null)) { return false; }
DateTime dt2 = new DateTime(dt1.Year, dt1.Month, dt1.Day, t2.Hour, t2.Minute, t2.Second);
return dt1 == dt2;
}
public static bool operator >(TimeOfDay t1, TimeOfDay t2)
{
if (ReferenceEquals(t1, t2)) { return true; }
else if (ReferenceEquals(t1, null)) { return true; }
else
{
return t1.TotalSeconds > t2.TotalSeconds;
}
}
public static bool operator >(TimeOfDay t1, DateTime dt2)
{
if (ReferenceEquals(t1, null)) { return false; }
DateTime dt1 = new DateTime(dt2.Year, dt2.Month, dt2.Day, t1.Hour, t1.Minute, t1.Second);
return dt1 > dt2;
}
public static bool operator >(DateTime dt1, TimeOfDay t2)
{
if (ReferenceEquals(t2, null)) { return false; }
DateTime dt2 = new DateTime(dt1.Year, dt1.Month, dt1.Day, t2.Hour, t2.Minute, t2.Second);
return dt1 > dt2;
}
public static bool operator >=(TimeOfDay t1, TimeOfDay t2)
{
if (ReferenceEquals(t1, t2)) { return true; }
else if (ReferenceEquals(t1, null)) { return true; }
else
{
return t1.TotalSeconds >= t2.TotalSeconds;
}
}
public static bool operator >=(TimeOfDay t1, DateTime dt2)
{
if (ReferenceEquals(t1, null)) { return false; }
DateTime dt1 = new DateTime(dt2.Year, dt2.Month, dt2.Day, t1.Hour, t1.Minute, t1.Second);
return dt1 >= dt2;
}
public static bool operator >=(DateTime dt1, TimeOfDay t2)
{
if (ReferenceEquals(t2, null)) { return false; }
DateTime dt2 = new DateTime(dt1.Year, dt1.Month, dt1.Day, t2.Hour, t2.Minute, t2.Second);
return dt1 >= dt2;
}
/// <summary>
/// Input examples:
/// 14:21:17 (2pm 21min 17sec)
/// 02:15 (2am 15min 0sec)
/// 2:15 (2am 15min 0sec)
/// 2/1/2017 14:21 (2pm 21min 0sec)
/// TimeOfDay=15:13:12 (3pm 13min 12sec)
/// </summary>
public static TimeOfDay Parse(string s)
{
// We will parse any section of the text that matches this
// pattern: dd:dd or dd:dd:dd where the first doublet can
// be one or two digits for the hour. But minute and second
// must be two digits.
Match m = _TodRegex.Match(s);
string text = m.Value;
string[] fields = text.Split(':');
if (fields.Length < 2) { throw new ArgumentException("No valid time of day pattern found in input text"); }
int hour = Convert.ToInt32(fields[0]);
int min = Convert.ToInt32(fields[1]);
int sec = fields.Length > 2 ? Convert.ToInt32(fields[2]) : 0;
return new TimeOfDay(hour, min, sec);
}
#endregion
private void Init(int hour, int minute, int second)
{
if (hour < 0 || hour > 23) { throw new ArgumentException("Invalid hour, must be from 0 to 23."); }
if (minute < 0 || minute > 59) { throw new ArgumentException("Invalid minute, must be from 0 to 59."); }
if (second < 0 || second > 59) { throw new ArgumentException("Invalid second, must be from 0 to 59."); }
Hour = hour;
Minute = minute;
Second = second;
}
private void Init(int hhmmss)
{
int hour = hhmmss / 10000;
int min = (hhmmss - hour * 10000) / 100;
int sec = (hhmmss - hour * 10000 - min * 100);
Init(hour, min, sec);
}
private void Init(DateTime dt)
{
Init(dt.Hour, dt.Minute, dt.Second);
}
}
}