R1.2.3

KSLCore/ksl.simulation/Executive

Executive

class Executive @JvmOverloads constructor(myEventCalendar: CalendarIfc = PriorityQueueEventCalendar()) : Observable<KSLEvent<*>?> (source)

Constructors

constructor(myEventCalendar: CalendarIfc = PriorityQueueEventCalendar())

Types

enum Status : Enum<Executive.Status>

Properties

allEventsExecuted

val allEventsExecuted: Boolean

beginExecutionTime

val beginExecutionTime: Instant

var currentTime: Double

elapsedExecutionTime

val elapsedExecutionTime: Duration

endedExecutionTime

val endedExecutionTime: Instant

var endingTime: Double

val isDone: Boolean

isEndConditionMet

val isEndConditionMet: Boolean

val isEnded: Boolean

isExecutionTimeExceeded

val isExecutionTimeExceeded: Boolean

val isInitialized: Boolean

val isRunning: Boolean

val isUnfinished: Boolean

maximumAllowedExecutionTime

var maximumAllowedExecutionTime: Duration

var maxScans: Int

var maxScansFlag: Boolean

numEventsExecuted

var numEventsExecuted: Long

numEventsScheduled

var numEventsScheduled: Long

numEventsScheduledDuringExecution

var numEventsScheduledDuringExecution: Double

var status: Executive.Status

stoppingMessage

val stoppingMessage: String?

terminationWarningMsgOption

var terminationWarningMsgOption: Boolean

Functions

fun hasNextEvent(): Boolean

Checks to see if the executive has another event

isEndEventScheduled

fun isEndEventScheduled(): Boolean

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

scheduledEndTime

fun scheduledEndTime(): Double

Returns the time the execution was scheduled to end

open override fun toString(): String

fun willTerminate(): Boolean

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