IterativeProcessIfc

The iterative process may end by a variety of means, this checks if the iterative process ended because it ran all of its steps, true if all completed

Gets the clock time as a Duration since the iterative process was initialized

Returns if the elapsed execution time exceeds the maximum time allowed. Only true if the maximum was set and elapsed time is greater than or equal to getMaximumAllowedExecutionTime()

The iterative process may end by a variety of means, this method checks if the iterative process ended but was unfinished, not all steps completed

Indicates that the iterative process ended because of no steps

The iterative process may end by a variety of means, this method checks if the iterative process ended because it was stopped, true if it was stopped via stop()

The iterative process will continue until there are no more steps or its maximum execution time has been reached, whichever comes first. If this method is called the iterative process will stop processing (terminate) before the next step and not process the next step in the process. The current step will be completed. This method can be used to stop the process at an arbitrary step. Once stopped, the process must be restarted.

Initializes the iterative process prior to running any steps This must be done prior to calling runNext();

Runs all the steps of the iterative process.

Runs the next step in the iterative process

This sets a flag to indicate to the process that it should stop after the next step is completed. This is different from end(). Calling end() immediately places the process in the End state. The process needs to be in a valid state before end() can be used. Calling stop tells the process to eventually get into the end state. stop() can be used to arbitrarily stop the process based on some user defined condition.