# HG changeset patch
# User IBBoard <dev@ibboard.co.uk>
# Date 1239286673 0
# Node ID 3c77722a02b5851751b8d08bbac2ec9597da2763
# Parent  0c3500fca49db5b6c060067caa5e82acd80303d8
Re #61 - Complete structure of WarFoundry API objects
 * Add containership support to Unit class
 * Add method to UnitType to check if a UnitType is of an allowed type

diff -r 0c3500fca49d -r 3c77722a02b5 IBBoard.WarFoundry.API.csproj
--- a/IBBoard.WarFoundry.API.csproj	Thu Apr 09 13:58:23 2009 +0000
+++ b/IBBoard.WarFoundry.API.csproj	Thu Apr 09 14:17:53 2009 +0000
@@ -124,6 +124,7 @@
     <Compile Include="api\Factories\Xml\WarFoundryXmlArmyFactory.cs" />
     <Compile Include="api\Factories\Xml\WarFoundryXmlFactoryUtils.cs" />
     <Compile Include="api\Factories\Xml\AbstractStagedLoadedSubFactory.cs" />
+    <Compile Include="api\Objects\InvalidContainershipException.cs" />
   </ItemGroup>
   <ItemGroup>
     <Content Include="libs\ICSharpCode.SharpZipLib.dll" />
diff -r 0c3500fca49d -r 3c77722a02b5 api/Objects/InvalidContainershipException.cs
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/api/Objects/InvalidContainershipException.cs	Thu Apr 09 14:17:53 2009 +0000
@@ -0,0 +1,46 @@
+//  This file (InvalidContainershipException.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard
+// 
+//  The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license.
+// 
+
+using System;
+
+namespace IBBoard.WarFoundry.API.Objects
+{
+	/// <summary>
+	/// A custom exception for when a unit was added as a sub-unit of another unit, but was not of a <see cref=" UnitType"/> that can be contained
+	/// by that unit.
+	/// </summary>
+	public class InvalidContainershipException : Exception
+	{
+		private Unit containing;
+		private Unit contained;
+		
+		public InvalidContainershipException(Unit containingUnit, Unit containedUnit) : base(CreateMessageString(containingUnit, containedUnit))
+		{
+			containing = containingUnit;
+			contained = containedUnit;
+		}
+		
+		private static string CreateMessageString(Unit containingUnit, Unit containedUnit)
+		{
+			return containingUnit.Name+" cannot contain "+containedUnit.Name+" because units of "+containingUnit.UnitType.Name+" cannot contain units of "+containedUnit.UnitType.Name;
+		}
+		
+		/// <value>
+		/// The <see cref=" Unit"/> that the contained unit was added to
+		/// </value>
+		public Unit ContainingUnit
+		{
+			get { return containing; }
+		}
+		
+		/// <value>
+		/// The <see cref=" Unit"/> that was added as a contained unit, but which was not of an allowed type
+		/// </value>
+		public Unit ContainedUnit
+		{
+			get { return contained; }
+		}
+	}
+}
diff -r 0c3500fca49d -r 3c77722a02b5 api/Objects/Unit.cs
--- a/api/Objects/Unit.cs	Thu Apr 09 13:58:23 2009 +0000
+++ b/api/Objects/Unit.cs	Thu Apr 09 14:17:53 2009 +0000
@@ -21,7 +21,8 @@
 		private Race race;
 		private double points;
 		private ArmyCategory cat;
-		private Dictionary<UnitEquipmentItem, double> equipment = new Dictionary<UnitEquipmentItem, double>();
+		private Dictionary<UnitEquipmentItem, double> equipment = new Dictionary<UnitEquipmentItem, double>();
+		private List<Unit> containedUnits = new List<Unit>();
 		public event DoubleValChangedDelegate PointsValueChanged;
 		public event IntValChangedDelegate UnitSizeChanged;
 		public event DoubleValChangedDelegate UnitEquipmentAmountChanged;
@@ -195,6 +196,31 @@
 
 				return points;
 			}
+		}
+		
+		public Unit[] ContainedUnits
+		{
+			get { return containedUnits.ToArray(); }
+		}
+		
+		public void AddContainedUnit(Unit unit)
+		{
+			if (UnitType.CanContainUnit(unit))
+			{
+				if (!containedUnits.Contains(unit))
+				{
+					containedUnits.Add(unit);
+				}
+			}
+			else
+			{
+				throw new InvalidContainershipException(this, unit);
+			}
+		}
+		
+		public void RemoveContainedUnit(Unit unit)
+		{
+			containedUnits.Remove(unit);
 		}
 
 		public UnitEquipmentItem[] GetAllowedOptionalEquipment()
diff -r 0c3500fca49d -r 3c77722a02b5 api/Objects/UnitType.cs
--- a/api/Objects/UnitType.cs	Thu Apr 09 13:58:23 2009 +0000
+++ b/api/Objects/UnitType.cs	Thu Apr 09 14:17:53 2009 +0000
@@ -359,6 +359,16 @@
 			notes.Add(note);
 		}
 		
+		public bool CanContainUnit(Unit unit)
+		{
+			return CanContainUnitType(unit.UnitType);
+		}
+		
+		public bool CanContainUnitType(UnitType unitType)
+		{
+			return containedTypes.Contains(unitType);
+		}
+		
 		public UnitType[] ContainedUnitTypes
 		{
 			get { return containedTypes.ToArray(); }