using System;

namespace Chernobyl.Switch
{
    /// <summary>
    /// The base interface for switches (also known as gates in boolean logic). 
    /// A switch is a type that generates one or more events when one or more
    /// predefined conditions are met.
    /// </summary>
    public interface ISwitch
    {
        /// <summary>
        /// An event that is raised when this switch has been switched on.
        /// </summary>
        event EventHandler SwitchedOn;

        /// <summary>
        /// An event that is raised right after this switch has been switched 
        /// off (or reset).
        /// </summary>
        event EventHandler SwitchedOff;

        /// <summary>
        /// Resets the switch to its original state or the its state after right
        /// after its creation.
        /// </summary>
        void Reset();

        /// <summary>
        /// An event handler that can be assigned to an event. This event handler
        /// will reset the switch to its original state. It is exactly the same
        /// as calling <see cref="ISwitch.Reset()"/>.
        /// </summary>
        /// <param name="sender">The sender of the event.</param>
        /// <param name="e">The arguments to the event.</param>
        void Reset(object sender, EventArgs e);
    }
}