// 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 and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING 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 double AmountTaken
		{
			get
			{
				return amountTaken;
			}
			set
			{
				amountTaken = value;
				
				if (!IsValidValue(value))
				{
					//Fire validation failed event (once we have one)
				}
			}
		}
		
		public bool IsValid
		{
			get
			{
				return IsValidValue(AmountTaken) && IsInRange(AmountTaken);
			}	
		}
		
		protected virtual bool IsValidValue(double newValue)
		{
			return true;
		}
		
		protected bool IsInRange(double newValue)
		{
			int unitSize = EquipmentForUnit.Size;
			int minLimit = EquipmentItem.MinLimit.GetLimit(unitSize);
			int maxLimit = EquipmentItem.MaxLimit.GetLimit(unitSize);
			return (minLimit <= newValue) && (newValue <= maxLimit);
		}
		
		public double TotalCost
		{
			get
			{
				return NumberTaken * EquipmentItem.Cost;
			}
		}

		/// <summary>
		/// Gets the number taken as a whole number of times the item was taken. This number will not be altered by the limits
		/// placed on the equipment item, which are instead used to raise validation warnings.
		/// </summary>
		/// <value>
		/// The number of times the item was taken.
		/// </value>
		public abstract int NumberTaken
		{
			 get;
		}
	}
}