/*
 * Node.cs
 * Authors:
 * 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;
using System.Collections.Generic;
using System.Text;

namespace ColonySim.Graphs
{
	/// <summary>
	/// Represents a Node in the resource graph.
	/// </summary>
	internal class Node
	{
		#region Fields

		// The list of adjacencies we have
		private List<Node> mAdjacencies = new List<Node>();

		#endregion

		#region Properties

		/// <summary>
		/// Expose the list of edges for use.
		/// </summary>
		public List<Node> Adjacencies
		{
			get { return mAdjacencies; }
		}

		/// <summary>
		/// Returns the number of adjacencies this Node has.
		/// </summary>
		public int NumberOfAdjacencies
		{
			get { return mAdjacencies.Count; }
		}

		#endregion

		#region Utility

		/// <summary>
		/// Add the given node to our adjacency list.
		/// </summary>
		/// <param name="pNode">The node to add.</param>
		public void AddAdjacency(Node pNode)
		{
			// If we don't contain that node
			if (!mAdjacencies.Contains(pNode))
			{
				// Add the node
				mAdjacencies.Add(pNode);
			}
		}

		/// <summary>
		/// Reemoves the given node from our adjacency list.
		/// </summary>
		/// <param name="pNode">The node to remove.</param>
		/// <returns>Whether we removed the adjacency or not.</returns>
		public bool RemoveAdjacency(Node pNode)
		{
			// Return
			return mAdjacencies.Remove(pNode);
		}

		/// <summary>
		/// Get the Node adjacency at the given index position.
		/// </summary>
		/// <param name="pIndex">The index for us to get the node at.</param>
		/// <returns>The adjacency at the given index.</returns>
		public Node GetAdjacency(int pIndex)
		{
			// Return the adjacency at the point in the adjacency list
			return mAdjacencies[pIndex];
		}

		/// <summary>
		/// Clears all of our adjacencies.
		/// </summary>
		public void ClearAdjacencies()
		{
			// Clear our adjacency list
			mAdjacencies.Clear();
		}

		#endregion
	}
}