KSLCore/ksl.simulation/Executive

Executive

class Executive(myEventCalendar: CalendarIfc = PriorityQueueEventCalendar()) : Observable<KSLEvent<*>?>

Constructors

Executive

constructor(myEventCalendar: CalendarIfc = PriorityQueueEventCalendar())

Types

Status

enum Status : Enum<Executive.Status>

Properties

allEventsExecuted

val allEventsExecuted: Boolean

beginExecutionTime

val beginExecutionTime: Instant

currentTime

var currentTime: Double

elapsedExecutionTime

val elapsedExecutionTime: Duration

endedExecutionTime

val endedExecutionTime: Instant

endingTime

var endingTime: Double

isDone

val isDone: Boolean

isEndConditionMet

val isEndConditionMet: Boolean

isEnded

val isEnded: Boolean

isExecutionTimeExceeded

val isExecutionTimeExceeded: Boolean

isInitialized

val isInitialized: Boolean

isRunning

val isRunning: Boolean

isUnfinished

val isUnfinished: Boolean

maximumAllowedExecutionTime

var maximumAllowedExecutionTime: Duration

maxScans

var maxScans: Int

maxScansFlag

var maxScansFlag: Boolean

numEventsExecuted

var numEventsExecuted: Long

numEventsScheduled

var numEventsScheduled: Long

numEventsScheduledDuringExecution

var numEventsScheduledDuringExecution: Double

status

var status: Executive.Status

stoppingMessage

val stoppingMessage: String?

terminationWarningMsgOption

var terminationWarningMsgOption: Boolean

Functions

attachObserver

open override fun attachObserver(observer: ObserverIfc<KSLEvent<*>?>)

Allows the adding (attaching) of an observer to the observable

countObservers

open override fun countObservers(): Int

Returns how many observers are currently attached to the observable

detachAllObservers

open override fun detachAllObservers()

Detaches all the observers from the observable

detachObserver

open override fun detachObserver(observer: ObserverIfc<KSLEvent<*>?>)

Allows the deletion (removing) of an observer from the observable

hasNextEvent

fun hasNextEvent(): Boolean

Checks to see if the executive has another event

isAttached

open override fun isAttached(observer: ObserverIfc<KSLEvent<*>?>): Boolean

Returns true if the observer is already attached

isEndEventScheduled

fun isEndEventScheduled(): Boolean

Returns true if an event has been scheduled to stop execution at getTimeHorizon()

observe

fun <T> Observable<T>.observe(block: (T?) -> Unit)

scheduledEndTime

fun scheduledEndTime(): Double

Returns the time the execution was scheduled to end

toString

open override fun toString(): String

willTerminate

fun willTerminate(): Boolean

If the Executive has an end event or maximum allowed execution time, then return true