A flag to indicate whether the iterative process is done A iterative process can be done if: 1) it ran all of its steps 2) it was ended by a client prior to completing all of its steps 3) it ended because it exceeded its maximum allowable execution time before completing all of its steps. 4) its end condition was satisfied

isEnded

open override val isEnded: Boolean

Checks if the iterative process is in the ended state. After the iterative process has been ended this property will return true

isInitialized

open override val isInitialized: Boolean

Checks if the iterative process is in the initialized state After the iterative process has been initialized this method will return true

isRunning

open override var isRunning: Boolean

An iterative process is running if it has been told to run (i.e. runNext()) but has not yet been told to end().

isRunningStep

open override var isRunningStep: Boolean

Indicates that the iterative process is currently running an individual step

isStepCompleted

open override val isStepCompleted: Boolean

Checks if the iterative process is in the completed step state After the iterative process has successfully completed a step this property will be true

maximumAllowedExecutionTime

open override var maximumAllowedExecutionTime: Duration

The maximum allotted (suggested) execution (real) clock for the entire iterative process in nanoseconds. This is a suggested time because the execution time requirement is only checked after the completion of an individual step After it is discovered that cumulative time for executing the step has exceeded the maximum time, then the iterative process will be ended (perhaps) not completing other steps.

numberStepsCompleted

open override var numberStepsCompleted: Int

Returns the number of steps completed since the iterative process was last initialized

stopping

open override var stopping: Boolean

Returns the stopping flag

stoppingMessage

open override var stoppingMessage: String?

A string message for why stop() was called.

Functions

end

override fun end(msg: String?)

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.

hasNextStep

abstract fun hasNextStep(): Boolean

This method should check to see if another step is necessary for the iterative process. True means that the process has another step to be executed. False, means that no more steps are available for execution.

initialize

override fun initialize()

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

run

override fun run()

Runs all the steps of the iterative process.

runNext

override fun runNext()

Runs the next step in the iterative process

stop

override fun stop(msg: String?)

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.

toString

open override fun toString(): String