// 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 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 object to hold the selection of a unit's equipment where the selection was made as an absolute number
	/// </summary>
	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.MinLimit.GetLimit(unit.Size))
		{
		}
					
		public override int NumberTaken
		{
			get
			{
				return (int) AmountTaken;
			}
		}
		
		protected bool IsWholeNumber(double newValue)
		{
			return newValue == Math.Round(newValue);
		}
		
		protected override bool IsValidValue (double newValue)
		{
			return base.IsValidValue(newValue) && IsWholeNumber(newValue);
		}

		public override string GetEquipmentAmountString ()
		{
			return GetEquipmentAmountString(AmountTaken);
		}

		/// <summary>
		/// Gets a string representing the amount of equipment taken when the amount is a numeric selection
		/// </summary>
		/// <param name="amount">
		/// A <see cref="System.Double"/>
		/// </param>
		/// <returns>
		/// A <see cref="System.String"/>
		/// </returns>
		public static string GetEquipmentAmountString(double amount)
		{
			return amount.ToString();
		}
	}
}