com.phoenix_int.aserver
Interface IPHXDriver

All Superinterfaces:

IPHXComponent

public interface IPHXDriver
extends IPHXComponent

this is the interface that drivers managed by the Analysis Server must implement.

initializeIterations

void initializeIterations()
                          throws java.lang.Exception

initializes the driver to a starting state. This function will be called once before a series of step() calls will be made. The function should reset things like iteration counts to initial values.

Throws:

java.lang.Exception - thrown if the function does not complete succesfully

startIteration

void startIteration()
                    throws java.lang.Exception

performs the first step for an iteration of a driver. The driver should set values for all output reference variables. The client application will load these values and compute new values for the input references.

Throws:

java.lang.Exception - thrown if the function does not complete succesfully

endIteration

boolean endIteration()
                     throws java.lang.Exception

performs the second step for an iteration of a driver. Prior to calling this function, the client application will have set values for all input reference variables. The driver should use these values to determine the next iteration, if any. return true if another iteration needs to be performed, false if the driver is complete

Throws:

java.lang.Exception - thrown if the function does not complete succesfully