FCC/Extension/GlobalPumpFdc/WayneLibraries/StateEngineG/TimerEvent.cs

#region  --------------- Copyright Dresser Wayne Pignone -------------
/*
 * $Log: /Wrk/WayneLibraries/Wrk/StateEngine/TimerEvent.cs $
 * 
 * 2     08-03-18 11:09 roger.månsson
 * Each timer does not have it's own real timer anymore. Instead there are
 * a pool of timers in the StateMachine that can be shared among the
 * timers in the same state machine.
 */
#endregion

namespace Wayne.Lib.StateEngine
{
    /// <summary>
    /// Event class for the Timer events. 
    /// </summary>
    public class TimerEvent : StateEngineEvent
    {
        #region Fields

        private object userToken;

        #endregion

        #region Construction

        /// <summary>
        /// Initializes a new instance of the TimerEvent. This event should only be created inside the 
        /// state machine, and does therefore not have any public constructor.
        /// </summary>
        ///<param name="userToken"></param>
        ///<param name="eventType"></param>
        internal TimerEvent(object userToken, object eventType)
            : base(eventType)
        {
            this.userToken = userToken;
        }

        #endregion

        #region Properties

        /// <summary>
        /// The UserToken of the Timer.
        /// </summary>
        public object UserToken
        {
            get
            {
                return userToken;
            }
        }

        #endregion
    }
}