view api/Objects/AbstractUnitEquipmentItemSelection.cs @ 97:95746083d037

Fixes #118: Allow equipment amounts of "ratio" equipment to be define as absolute or ratio amounts * Add extra "NumericSelection" type so that ratio selections check the absolute value is within their ratio range * Update structure of checking for valid values * Move cost calculation for equipment selection in to abstract class and add abstract method to get "number of items taken" * Handle numeric selection and numeric selection for ratio differently in Unit
author IBBoard <dev@ibboard.co.uk>
date Sun, 09 Aug 2009 12:02:35 +0000
parents ced5a18d9f52
children f7b9423c2a5a
line wrap: on
line source

// 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 double AmountTaken
		{
			get 
			{
				return amountTaken;
			}
			set
			{
				if (IsValidValue(value))
				{
					amountTaken = value;
				}
				else
				{
					//Fire validation failed event (once we have one)
				}
			}
		}
		
		protected bool IsValidValue(double newValue)
		{
			return IsInRange(newValue);
		}
		
		protected abstract bool IsInRange(double newValue);
		
		public double TotalCost
		{
			get
			{
				return NumberTaken * EquipmentItem.Cost;
			}
		}
		
		public abstract int NumberTaken
		{
			 get;
		}
	}
}