Added members for a team and exceptions for assigned personnel

Author: point85

README.md

@@ -11,10 +11,23 @@ The diagram below illustrates Business Management Systems' DNO (Day, Night, Off)
 
 A shift is defined with a name, description, starting time of day and duration.  An off-shift period is associated with a shift.  In the example above for Team1, there are two shifts followed by one off-shift period.  Shifts can be overlapped (typically when a handoff of duties is important such as in the nursing profession).  A rotation is a sequence of shifts and off-shift days.  The DNO rotation is Day on, Night on and Night off.  An instance of a shift has a starting date and time of day and has an associated shift definition.
 
+*Break*
+
+A break is a defined working period of time during a shift, for example lunch.  A shift can have zero or more breaks.
+
 *Team*
 
 A team is defined with a name and description.  It has a rotation with a starting date.  The starting date shift will have an instance with that date and a starting time of day as defined by the shift.  The same rotation can be shared between more than one team, but with different starting times.
 
+*Team Member*
+
+A team member is a person assigned to a team.  The member is identified by a member ID (e.g. employee ID), name and description/title.
+
+*Team Member Exception*
+
+A team member exception is an addition and/or removal from the assigned members of a team for a specified shift instance.  The instance is identified by the starting date and time.
+
+
 *Work Schedule*
 
 A work schedule is defined with a name and description.  It has one or more teams.  Zero or more non-working periods can be defined.  A non-working period has a defined starting date and time of day and duration.  For example, the New Year's Day holiday starting at midnight for 24 hours, or three consecutive days for preventive maintenance of manufacturing equipment starting at the end of the night shift. 
@@ -219,6 +232,39 @@ Working shifts
    (1) Team: Green, Shift: 24 Hour, Start : 2017-02-07T07:00, End : 2017-02-08T07:00
 ```
 
+For a fourth example, for a restaurant shift starting at 7 am on August 8, 2024, team member #1 called in sick and is to be replaced by member #10:
+```cs
+WorkSchedule schedule = new WorkSchedule("Restaurant", "Two shifts");
+
+// day shift (12 hours)
+Shift day = schedule.CreateShift("Day", "Green", new LocalTime(6, 0, 0), Duration.FromHours(12));
+
+// day shift rotation, 1 days ON, 0 OFF
+Rotation dayRotation = schedule.CreateRotation("Day", "One day on, 6 off");
+dayRotation.AddSegment(day, 1, 6);
+
+LocalDate greenStart = new LocalDate(2024, 7, 28);
+Team sundayDay = schedule.CreateTeam("SundayDay", "Sunday day", dayRotation, greenStart);
+
+// chef members
+TeamMember one = new TeamMember("Chef, One", "Chef", "1");
+TeamMember ten = new TeamMember("Ten", "Ten description", "10");
+
+sundayDay.AddMember(one);
+
+// replace member one with ten
+LocalDateTime exceptionShift = new LocalDateTime(2024, 8, 11, 7, 0, 0);
+TeamMemberException replacement = new TeamMemberException(exceptionShift);
+replacement.Removal = one;
+replacement.Addition = ten;
+sundayDay.AddMemberException(replacement);
+
+// #1 is in the assigned list
+List<TeamMember> members = sundayDay.AssignedMembers;
+
+// but is replaced by #10 for that shift instance:
+members = sundayDay.GetMembers(exceptionShift);
+```
 ## Project Structure
 ShiftSharp depends upon .Net Framework 4.5+ due to use of the NodaTime date and time classes.
 

Release Notes.txt

@@ -4,4 +4,8 @@
 
 v2.0.0: January 20, 2024
     - Upgraded v1.0.0 to .NET 8
+	- Published to NuGet
+	
+v2.1.0: December 17, 2024
+	- Added members for a team and exceptions for assigned personnel	
 	- Published to NuGet

ShiftSharp/Documentation/html_docs.zip

@@ -222,4 +222,10 @@
   <data name="team.hours" xml:space="preserve">
     <value>Average hours worked per week</value>
   </data>
+  <data name="team.members" xml:space="preserve">
+    <value>Members:</value>
+  </data>  
+  <data name="member.id" xml:space="preserve">
+    <value>ID</value>
+  </data>   
 </root>

ShiftSharp/Properties/Resources.resx

@@ -101,9 +101,15 @@ public override string ToString()
 			string s = WorkSchedule.GetMessage("shift");
 			string ps = WorkSchedule.GetMessage("period.start");
 			string pe = WorkSchedule.GetMessage("period.end");
+			String members = WorkSchedule.GetMessage("team.members");
 
 			string text = " " + t + ": " + Team.Name + ", " + s + ": " + Shift.Name + ", " + ps + ": "
-					+ StartDateTime + ", " + pe + ": " + GetEndTime();
+					+ StartDateTime + ", " + pe + ": " + GetEndTime() +"\n" + members;
+
+			foreach (TeamMember member in this.Team.GetMembers(StartDateTime))
+			{
+				text += "\n\t" + member;
+			}
 			return text;
 		}
 	}

ShiftSharp/ShiftInstance.cs

@@ -8,19 +8,21 @@
     <Description>C# work schedule library</Description>
     <Company>Point85</Company>
     <Product>ShiftSharp</Product>
-    <Copyright>Copyright ©  2017</Copyright>
-    <AssemblyVersion>2.0.0.0</AssemblyVersion>
-    <FileVersion>2.0.0.0</FileVersion>
+    <Copyright>Copyright ©  2017-2024</Copyright>
+    <AssemblyVersion>2.1.0.0</AssemblyVersion>
+    <FileVersion>2.1.0.0</FileVersion>
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <Title>Work schedule library</Title>
-    <Version>2.0.1</Version>
+    <Version>2.1.0</Version>
+    <Authors>Kent Randall</Authors>
+    <PackageId>ShiftSharp</PackageId>
     <PackageProjectUrl>https://github.com/point85/ShiftSharp</PackageProjectUrl>
     <PackageIcon>WorkSchedule.png</PackageIcon>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryUrl>https://github.com/point85/ShiftSharp</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageTags>C#; shift; work schedule; shift calendar; work calendar</PackageTags>
-    <PackageReleaseNotes>Upgraded to .NET 8</PackageReleaseNotes>
+    <PackageReleaseNotes>Added team members and exceptions</PackageReleaseNotes>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <ApplicationIcon>WorkSchedule.ico</ApplicationIcon>
     <Nullable>disable</Nullable>

ShiftSharp/ShiftSharp.csproj

@@ -24,6 +24,9 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
 using NodaTime;
 using System;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
+using static System.Runtime.InteropServices.JavaScript.JSType;
 
 namespace Point85.ShiftSharp.Schedule
 {
@@ -47,6 +50,19 @@ public class Team : Named, IComparable<Team>
 		/// </summary>
 		public Rotation Rotation { get; set; }
 
+		/// <summary>
+		/// Team members assigned to work regular shifts
+		/// </summary>
+		public List<TeamMember> AssignedMembers { get; private set; } = new List<TeamMember>();
+
+		/// <summary>
+		/// Team member exceptions to regular shifts
+		/// </summary>
+		public List<TeamMemberException> MemberExceptions { get; private set; } = new List<TeamMemberException>();
+
+		// team member exception cache by shift instance start
+		private ConcurrentDictionary<LocalDateTime, TeamMemberException> ExceptionCache;
+
 		/// <summary>
 		/// Constructor
 		/// </summary>
@@ -273,21 +289,136 @@ public int CompareTo(Team other)
 		public override string ToString()
 		{
 			string rpct = WorkSchedule.GetMessage("rotation.percentage");
-
 			string rs = WorkSchedule.GetMessage("rotation.start");
 			string avg = WorkSchedule.GetMessage("team.hours");
+			string members = WorkSchedule.GetMessage("team.members");
 
 			string text = "";
 			try
 			{
 				text = base.ToString() + ", " + rs + ": " + RotationStart + ", " + Rotation + ", " + rpct + ": "
-						+ GetPercentageWorked().ToString("0.00") + "%" + ", " + avg + ": " + GetHoursWorkedPerWeek();
+						+ GetPercentageWorked().ToString("0.00") + "%" + ", " + avg + ": " + GetHoursWorkedPerWeek() + "\n"
+					+ members;
+
+				foreach (TeamMember member in AssignedMembers)
+				{
+					text += "\n\t" + member;
+				}
 			}
 			catch (Exception)
 			{
 			}
 
 			return text;
 		}
+
+		/// <summary>
+		/// Add a member to this team
+		/// </summary>
+		/// <param name="member">Team member</param>
+		public void AddMember(TeamMember member)
+		{
+			if (!this.AssignedMembers.Contains(member))
+			{
+				this.AssignedMembers.Add(member);
+			}
+		}
+
+		/// <summary>
+		/// Remove a member from this team
+		/// </summary>
+		/// <param name="member">Team member</param>
+		public void removeMember(TeamMember member)
+		{
+			if (this.AssignedMembers.Contains(member))
+			{
+				this.AssignedMembers.Remove(member);
+			}
+		}
+
+		/// <summary>
+		/// True if member is assigned to this team
+		/// </summary>
+		/// <param name="member">Team member</param>
+		/// <returns>bool</returns>
+		public bool HasMember(TeamMember member)
+		{
+			return this.AssignedMembers.Contains(member);
+		}
+
+		/// <summary>
+		/// Add a member exception for this team
+		/// </summary>
+		/// <param name="memberException">Team member exception</param>
+		public void AddMemberException(TeamMemberException memberException)
+		{
+			this.MemberExceptions.Add(memberException);
+
+			// invalidate cache
+			this.ExceptionCache = null;
+		}
+
+		/// <summary>
+		/// Remove a member exception for this team
+		/// </summary>
+		/// <param name="memberException">Team member exception</param>
+		public void RemoveMemberException(TeamMemberException memberException)
+		{
+			this.MemberExceptions.Remove(memberException);
+
+			// invalidate cache
+			this.ExceptionCache = null;
+		}
+
+		/// <summary>
+		/// Build a list of team member for the specified shift start
+		/// </summary>
+		/// <param name="shiftStart">Shift instance starting date and time</param>
+		/// <returns>List of team members</returns>
+
+		public List<TeamMember> GetMembers(LocalDateTime shiftStart)
+		{
+			List<TeamMember> members = new List<TeamMember>();
+
+			// build the cache if not already done
+			BuildMemberCache();
+
+			// members assigned to the team
+			foreach (TeamMember member in AssignedMembers)
+			{
+				members.Add(member);
+			}
+
+			// any exceptions?
+			if (ExceptionCache.TryGetValue(shiftStart, out TeamMemberException tme))
+			{
+				if (tme.Addition != null)
+				{
+					members.Add(tme.Addition);
+				}
+
+				if (tme.Removal!= null)
+				{
+					members.Remove(tme.Removal);
+				}
+			}
+			return members;
+		}
+
+		private void BuildMemberCache()
+		{
+			if (ExceptionCache == null)
+			{
+				// create it
+				ExceptionCache = new ConcurrentDictionary<LocalDateTime, TeamMemberException>();
+			}
+
+			ExceptionCache.Clear();
+
+			foreach (TeamMemberException tme in MemberExceptions)
+			{
+				ExceptionCache[tme.DateTime] = tme;
+			}
+		}
 	}
 }