mil.af.afit.uvr
Class HEngineEvent

java.lang.Object
  |
  +--mil.af.afit.uvr.HEngineEvent

public class HEngineEvent
extends java.lang.Object

These events get passed from the engine to interested listeners

Since:
1.0
See Also:
HEngine, HEngineListener

Field Summary
static int ENGINE_FINISHED
          The event type when the engine has finished.
static int ENGINE_STARTED
          The event type when the engine has started
static int NEW_BEST_SOLUTION
          The event type when the engine has found a new best solution.
static int PERCENT_DONE
          The event type when the engine has reported its progress.
static int SOLVER_STARTED
          The event type when a solver has started
 
Constructor Summary
HEngineEvent(int eventType, java.lang.Object source)
          Constructor for HEngineEvent
 
Method Summary
 int getEventType()
          Returns the event type.
 HEngine getHEngine()
          Returns the source of the event, casted to HEngine.
 java.lang.Object getSource()
          Returns the source of the event.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ENGINE_STARTED

public static final int ENGINE_STARTED
The event type when the engine has started
Since:
1.0

ENGINE_FINISHED

public static final int ENGINE_FINISHED
The event type when the engine has finished.
Since:
1.0

PERCENT_DONE

public static final int PERCENT_DONE
The event type when the engine has reported its progress.
Since:
1.0

NEW_BEST_SOLUTION

public static final int NEW_BEST_SOLUTION
The event type when the engine has found a new best solution.
Since:
1.0

SOLVER_STARTED

public static final int SOLVER_STARTED
The event type when a solver has started
Since:
1.0
Constructor Detail

HEngineEvent

public HEngineEvent(int eventType,
                    java.lang.Object source)
Constructor for HEngineEvent
Parameters:
eventType - event type
source - source of the event. Normally this is passed.
Since:
1.0
Method Detail

getSource

public final java.lang.Object getSource()
Returns the source of the event. It should be of type HEngine
Returns:
source of the event.
Since:
1.0
See Also:
HEngine

getHEngine

public final HEngine getHEngine()
Returns the source of the event, casted to HEngine. This is identical to

     (HEngine) e.getSource();
 
Returns:
source of the event.
Since:
1.0
See Also:
HEngine

getEventType

public final int getEventType()
Returns the event type.
Returns:
event type
Since:
1.0

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object