KSLCore/ksl.utilities.statistic/State

State

open class State(theStateNumber: Int = stateCounter + 1, name: String = "State:", useStatistic: Boolean = false) : IdentityIfc, StateAccessorIfc

Create a state with given name and indicate usage of a Statistic object to collect additional statistics

Parameters

name

The name of the state

theStateNumber

a number assigned to the state for labeling purposes

useStatistic

True means collect sojourn time statistics

Constructors

constructor(theStateNumber: Int = stateCounter + 1, name: String = "State:", useStatistic: Boolean = false)

Properties

open override val id: Int

open override var isEntered: Boolean

indicates whether currently in the state

open override var label: String?

open override val name: String

val number: Int

A user defined integer label for the state

numberOfTimesEntered

open override var numberOfTimesEntered: Double

number of times the state was entered

numberOfTimesExited

open override var numberOfTimesExited: Double

number of times the state was exited

sojournTimeCollectionFlag

var sojournTimeCollectionFlag: Boolean

Indicates whether statistics should be collected on time spent in the state. The default is false

sojournTimeStatistic

open override var sojournTimeStatistic: Statistic?

statistical collector

timeFirstEntered

open override var timeFirstEntered: Double

time that the state was entered for the first time

open val timeInState: Double

timeStateEntered

open override var timeStateEntered: Double

time the state was last entered

timeStateExited

open override var timeStateExited: Double

time the state was last exited

totalTimeInState

open override var totalTimeInState: Double

Total time spent in state

Functions

fun enter(time: Double)

Causes the state to be entered If the state has already been entered then nothing happens. Preconditions: time must be >= 0, must not be Double.NaN and must not be Double.Infinity

fun exit(time: Double): Double

Causes the state to be exited

fun initialize()

Initializes the state back to new

resetSojournTimeStatistics

fun resetSojournTimeStatistics()

Resets the statistics collected on the sojourn time in the state

resetStateCollection

fun resetStateCollection()

Resets the counters for the number of times a state was entered, exited, and the total time spent in the state This does not affect whether or the state has been entered, the time it was last entered, or the time it was last exited. To reset those quantities and the state counters use initialize()

open override fun toString(): String