/////////////////////////////////////////////////////////////////////////////////
// Copyright © 2008-2010  W. Kowarschick 
//
// Permission is granted to copy, distribute and/or modify this document
// under the terms of the WK License, Version 1.0 (WKL 1.0) or any later version 
// published by Wolfgang Kowarschick.
/////////////////////////////////////////////////////////////////////////////////

package wki.automaton
{ 
  import flash.events.IEventDispatcher;

  public interface WKI_Automaton extends IEventDispatcher
  {
    /////////////////////////////////////////////////////////////////////////////
    // Methods
    /////////////////////////////////////////////////////////////////////////////

/**
 *  Resets the automaton. That is to say, the current state is
 *  set to the initial state, an an event of type 
 *  WK_AutomatonEvent is dispatched. As parameters,
 *  <code>INIT</code> (as action), the current state and an empty string (for
 *  the previous state) are stored in that event.
 */
    function reset(): void;

/**
 *  Switches the automaton into a new state depending on the current state
 *  and the user action <code>p_action</code>. Several 
 *  <code>WK_AutomatonEvent</code>s may be dispatched.
 *
 *  @param p_action The (user) action that determines the transition to be used.
 */
    function doAction(p_action: String): void;

    /////////////////////////////////////////////////////////////////////////////
    // End of Class 
    /////////////////////////////////////////////////////////////////////////////
  }
}