/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* This library is free software; you can redistribute it and/or     */
/* modify it under the terms of the GNU Lesser General Public        */
/* License as published by the Free Software Foundation,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* This library 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 */
/* Lesser General Public License for more details.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;
using System.Threading;

namespace AgentService.Agent.Behaviour
{
	/// <summary>
	/// Class BehaviourScheduleUnit. Unit of schedule for a behaviour object.
	/// </summary>
	[Serializable]
	public class BehaviourScheduleUnit
	{	
		/// <summary>
		/// Thread that schedules the Behaviour
		/// </summary>
		private Thread thread;

		/// <summary>
		/// Gets, sets the scheduling priority for the Behavoiur
		/// </summary>
		public ThreadPriority Priority
		{
			get
			{
				return this.thread.Priority;
			}
			set
			{
				this.thread.Priority = value;
			}
		}

		/// <summary>
		/// Behaviour instance 
		/// </summary>
		public Behaviour behaviour;

		

		/// <summary>
		/// Constructs a BehaviourScheduleUnit for the given Behaviour
		/// </summary>
		/// <param name="behaviour">The Behaviour to be scheduled</param>
		public BehaviourScheduleUnit(Behaviour behaviour)
		{
			this.behaviour = behaviour;
            this.thread = new Thread(new ThreadStart(this.behaviour.Execute));
            this.thread.Name = String.Format("{0}#{1}", behaviour.Owner.Name, behaviour.Name);
        }

		/// <summary>
		/// Constructs a BehaviourScheduleUnit for the given Behaviour with a specified priority
		/// </summary>
		/// <param name="behaviour">The Behaviour to be scheduled</param>
		/// <param name="priority">The priority for the Behaviour</param>
		public BehaviourScheduleUnit(Behaviour behaviour, ThreadPriority priority)
		{
			this.behaviour = behaviour;
			this.thread = new Thread(new ThreadStart(this.behaviour.Execute));
			this.Priority = priority;
 		}
		
		/// <summary>
		/// Starting the Body of the associeted Behaviour
		/// </summary>
		public void Start()
		{
			this.thread.Start();
		}
		
		/// <summary>
		/// Abort the execution of the wrapped thread
		/// </summary>
		public void Abort()
		{
			this.thread.Abort();
		}

		/// <summary>
		/// Resume the execution of the wrapped thread
		/// </summary>
		public void Resume()
		{
			this.thread.Resume();
		}
		
		/// <summary>
		/// Suspend the execution of the wrapped thread
		/// </summary>
		public void Suspend()
		{
			this.thread.Suspend();
		}
		/// <summary>
		/// At Behaviour's end
		/// Release the Knowledge locked by the Behaviour
		/// </summary>
		public void Release()
		{
			try
			{
				this.behaviour.ReleaseKnowledge(true);
			}
			catch(AgentService.Agent.Knowledge.KnowledgeUnlockedException e)
			{
				// Put log
				Console.WriteLine(e.Message);
			}
		}

		/// <summary>
		/// Overrides Equals method
		/// </summary>
		/// <param name="obj">The object to compare to</param>
		/// <returns>true if Behaviour fields are the same</returns>
		public override bool Equals(object obj)
		{
			BehaviourScheduleUnit bsu = obj as BehaviourScheduleUnit;
			if (bsu == null)
			{
				return false;
			}
			return this.behaviour.Equals(bsu.behaviour);
		}
        /// <summary>
        /// Gets the hash code for this BehaviourScheduleUnit instance.
        /// </summary>
        /// <returns>wrapped behaviour has code</returns>
        public override int GetHashCode()
        {
            return this.behaviour.GetHashCode();
        }

	}
}