changeset 95:6c6cfe5594fc

Re #118: Allow equipment amounts of "ratio" equipment to be define as absolute or ratio amounts * Create new "equipment selection" objects to track equipment selection amounts and cost * Create ratio version * Creat absolute amount version
author IBBoard <dev@ibboard.co.uk>
date Sun, 09 Aug 2009 10:34:09 +0000
parents 49a83020174e
children ced5a18d9f52
files api/Objects/AbstractUnitEquipmentItemSelection.cs api/Objects/UnitEquipmentNumericSelection.cs api/Objects/UnitEquipmentRatioSelection.cs
diffstat 3 files changed, 141 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/api/Objects/AbstractUnitEquipmentItemSelection.cs	Sun Aug 09 10:34:09 2009 +0000
@@ -0,0 +1,67 @@
+// This file (AbstractUnitEquipmentItemSelection.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>
+	/// An abstract class that defines a selection of equipment for a unit
+	/// </summary>	
+	public abstract class AbstractUnitEquipmentItemSelection
+	{
+		private Unit selectionForUnit;
+		private UnitEquipmentItem selectedItem;
+		private double amountTaken;
+		
+		public AbstractUnitEquipmentItemSelection(Unit unit, UnitEquipmentItem item, double amount)
+		{
+			selectionForUnit = unit;
+			selectedItem = item;
+			amountTaken = amount;
+		}
+		
+		public Unit EquipmentForUnit
+		{
+			get
+			{
+				return selectionForUnit;
+			}
+		}
+		
+		public UnitEquipmentItem EquipmentItem
+		{
+			get
+			{
+				return selectedItem;
+			}
+		}
+		
+		public abstract double TotalCost
+		{
+			get;
+		}
+		
+		public double AmountTaken
+		{
+			get 
+			{
+				return amountTaken;
+			}
+			set
+			{
+				if (IsValidValue(value))
+				{
+					amountTaken = value;
+				}
+				else
+				{
+					//Fire validation failed event (once we have one)
+				}
+			}
+		}
+		
+		protected abstract bool IsValidValue(double newValue);
+	}
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/api/Objects/UnitEquipmentNumericSelection.cs	Sun Aug 09 10:34:09 2009 +0000
@@ -0,0 +1,32 @@
+// This file (UnitEquipmentNumericSelection.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
+{	
+	public class UnitEquipmentNumericSelection : AbstractUnitEquipmentItemSelection
+	{	
+		public UnitEquipmentNumericSelection(Unit unit, UnitEquipmentItem item, double amount) : base(unit, item, amount)
+		{
+		}
+		
+		public UnitEquipmentNumericSelection(Unit unit, UnitEquipmentItem item) : base(unit, item, item.MinNumber)
+		{
+		}
+		
+		public override double TotalCost
+		{
+			get
+			{
+				return AmountTaken * EquipmentItem.Cost;
+			}
+		}
+		
+		protected override bool IsValidValue (double newValue)
+		{
+			return newValue = Math.Round(newValue);
+		}
+	}
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/api/Objects/UnitEquipmentRatioSelection.cs	Sun Aug 09 10:34:09 2009 +0000
@@ -0,0 +1,42 @@
+// This file (UnitEquipmentRatioSelection.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>
+	/// An object to hold the selection of a unit's equipment where the selection was made as a percentage or ratio
+	/// of the total size of the unit
+	/// </summary>
+	public class UnitEquipmentRatioSelection : AbstractUnitEquipmentItemSelection
+	{	
+		public UnitEquipmentRatioSelection(Unit unit, UnitEquipmentItem item, double amount) : base(unit, item, amount)
+		{
+		}
+		
+		public UnitEquipmentRatioSelection(Unit unit, UnitEquipmentItem item) : base(unit, item, item.MinPercentage)
+		{
+		}
+		
+		public override double TotalCost
+		{
+			get
+			{
+				return CalculateAmount() * EquipmentItem.Cost;
+			}
+		}
+					
+		private double CalculateAmount()
+		{
+			double numberTaken = AmountTaken * EquipmentForUnit.Size;
+			return (EquipmentItem.RoundNumberUp ? Math.Ceiling(numberTaken) : Math.Floor(numberTaken));
+		}
+		
+		protected override bool IsValidValue (double newValue)
+		{
+			return (EquipmentItem.MinPercentage <= newValue) && (newValue <= EquipmentItem.MaxPercentage);
+		}
+	}
+}