/*
 * Tier.cs
 * Authors: Bradley R. Blankenship
 * Copyright (c) 2007-2008 Cornell University

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

using System.Collections.Generic;
using ColonySim.Structures;

namespace ColonySim
{
	/// <summary>
	/// Represents the current Tier of resources and buildings that the player
	/// has access to.
	/// </summary>
	internal class Tier
	{
		#region Fields

		// The list of structures that the player has access to
		private List<Structure> mStructures = new List<Structure>();

		// The list of resources that the player has access to
		private List<ResourceCode> mResources = new List<ResourceCode>();

		// The next Tier
		private Tier mNextTier;

		// Requirement for this Tier
		private int mRequiredPlays;

		// The name of the Tier
		private string mName = "DefaultName";

		#endregion

		#region Properties

		/// <summary>
		/// Gets the list of available structures for the Tier.
		/// </summary>
		public Structure[] Structures
		{
			get { return mStructures.ToArray(); }
		}

		/// <summary>
		/// Gets the list of available resources for the Tier.
		/// </summary>
		public ResourceCode[] Resources
		{
			get { return mResources.ToArray(); }
		}

		/// <summary>
		/// Allows the getting of the Next Tier for the game.
		/// </summary>
		public Tier NextTier
		{
			get { return mNextTier; }
		}

		/// <summary>
		/// Allows access to the number of required plays for the tier to
		/// be accessible.
		/// </summary>
		public int RequiredPlays
		{
			get { return mRequiredPlays; }
			set { mRequiredPlays = value; }
		}

		/// <summary>
		/// Allows access to the name of the given tier.
		/// </summary>
		public string Name
		{
			get { return mName; }
			set { mName = value; }
		}

		#endregion

		#region Constructs

		/// <summary>
		/// Creates the Tier.
		/// </summary>
		/// <param name="pStructures">The list of structures</param>
		/// <param name="pResources">The list of resources</param>
		/// <param name="pNext">The next Tier, if there is one.</param>
		public Tier(IEnumerable<Structure> pStructures, IEnumerable<ResourceCode> pResources, Tier pNext)
		{
			// Add all of the values
			mStructures.AddRange(pStructures);
			mResources.AddRange(pResources);
			mNextTier = pNext;
		}

		#endregion
	}
}