KSLCore/ksl.modeling.elements

Package-level declarations

Types

open class EventGenerator(parent: ModelElement, generateAction: GeneratorActionIfc?, timeUntilFirstRV: RVariableIfc, timeBtwEventsRV: RVariableIfc, maxNumberOfEvents: Long = Long.MAX_VALUE, timeOfTheLastEvent: Double = Double.POSITIVE_INFINITY, name: String? = null) : ModelElement, EventGeneratorIfc, EventGeneratorInitializationCIfc, EventGeneratorRVIfc, EventGeneratorRVCIfc

EventGeneratorCIfc

interface EventGeneratorCIfc : EventGeneratorTimeUntilFirstEventCIfc, EventGeneratorInitialTimeBtwEventsCIfc, EventGeneratorInitializationCIfc, EventGeneratorInitialEventTimeProcessesCIfc

Permits controlled access to the underlying event generator. Of particular note are the timeUntilFirstEvent and initialTimeBtwEvents properties which govern the arrival process. In addition, the function setInitialEventTimeProcesses() is provided to facilitate the setting of both timeUntilFirstEvent and initialTimeBtwEvents to the same reference, which is a common use case.

EventGeneratorIfc

interface EventGeneratorIfc

An interface to define how event generators operate. The primary subclass is EventGenerator. Of particular note is the use of initial parameters:

EventGeneratorInitialEventTimeProcessesCIfc

interface EventGeneratorInitialEventTimeProcessesCIfc

EventGeneratorInitialEventTimeProcessesRVCIfc

interface EventGeneratorInitialEventTimeProcessesRVCIfc

EventGeneratorInitializationCIfc

interface EventGeneratorInitializationCIfc

EventGeneratorInitialTimeBtwEventsCIfc

interface EventGeneratorInitialTimeBtwEventsCIfc

EventGeneratorInitialTimeBtwEventsRVCIfc

interface EventGeneratorInitialTimeBtwEventsRVCIfc

EventGeneratorRVCIfc

interface EventGeneratorRVCIfc : EventGeneratorTimeUntilFirstEventRVCIfc, EventGeneratorInitialTimeBtwEventsRVCIfc, EventGeneratorInitializationCIfc, EventGeneratorInitialEventTimeProcessesRVCIfc

EventGeneratorRVIfc

interface EventGeneratorRVIfc : EventGeneratorTimeUntilFirstEventRVCIfc, EventGeneratorInitialTimeBtwEventsRVCIfc, EventGeneratorTimeBtwEventsRVIfc, EventGeneratorInitialEventTimeProcessesRVCIfc

EventGeneratorTimeBtwEventsIfc

interface EventGeneratorTimeBtwEventsIfc

EventGeneratorTimeBtwEventsRVIfc

interface EventGeneratorTimeBtwEventsRVIfc

EventGeneratorTimeUntilFirstEventCIfc

interface EventGeneratorTimeUntilFirstEventCIfc

EventGeneratorTimeUntilFirstEventRVCIfc

interface EventGeneratorTimeUntilFirstEventRVCIfc

GeneratorActionIfc

fun interface GeneratorActionIfc

This interface defines the action to occur for an EventGenerator. Implementors place code in the method generate() in order to provide actions that can occur when the event that was generated is executed.

RandomElement

abstract class RandomElement(parent: ModelElement, rSource: RandomIfc, name: String? = null) : ModelElement, RandomElementIfc, RandomSourceCIfc, StreamNumberIfc

RandomElementIfc

interface RandomElementIfc : RNStreamControlIfc

A tagging interface that is used to facilitate stream control for model elements that require randomness

RandomEmpiricalMap

class RandomEmpiricalMap<K, V>(parent: ModelElement, rMap: REmpiricalMap<K, V>, name: String? = null) : ModelElement, Map<K, V> , RElementIfc<V>

Allows random selection of elements from the map. The supplied map must have at least one element. The supplied array must represent a valid cumulative distribution function over the same number of elements as in the map.

RandomList

class RandomList<T : Any>(parent: ModelElement, dUniformList: DUniformList<T>, name: String? = null) : ModelElement, RElementIfc<T> , RandomElementIfc

RandomMap

class RandomMap<K, V>(parent: ModelElement, rMap: RMap<K, V>, name: String? = null) : ModelElement, Map<K, V> , RElementIfc<V> , RandomElementIfc

Allows random selection of elements from the map. The supplied map must have at least one element

REmpiricalList

class REmpiricalList<T>(parent: ModelElement, dEmpiricalList: DEmpiricalList<T>, name: String? = null) : ModelElement, RElementIfc<T> , RandomElementIfc

Schedule

class Schedule(parent: ModelElement, startTime: Double = 0.0, length: Double = Double.POSITIVE_INFINITY, autoStartOption: Boolean = true, repeatable: Boolean = true, startPriority: Int = KSLEvent.DEFAULT_PRIORITY - 5, itemPriority: Int = KSLEvent.DEFAULT_PRIORITY - 4, name: String? = null) : ModelElement, ScheduleCIfc

A Schedule represents a known set of events that can occur according to a pattern. A schedule contains one or more instances of ScheduleItem. A ScheduleItem represents an item on a Schedule. It has a start time, relative to the start of the Schedule and a duration. If more than one schedule item needs to start at the same time, then a priority can be provided to determine the ordering (i.e. the smallest priority goes first). ScheduleItems are not scheduled to occur until the Schedule actually starts.

ScheduleChangeListenerIfc

interface ScheduleChangeListenerIfc

ScheduleCIfc

interface ScheduleCIfc : JsonSettingsIfc<ScheduleData>

ScheduleData

@Serializable

data class ScheduleData(var initialStartTime: Double = 0.0, var scheduleLength: Double = Double.POSITIVE_INFINITY, var isAutoStartFlag: Boolean = true, var isScheduleRepeatable: Boolean = true, var startEventPriority: Int = KSLEvent.DEFAULT_PRIORITY - 5, var itemStartEventPriority: Int = KSLEvent.DEFAULT_PRIORITY - 4, val scheduleItemDataList: List<ScheduleItemData>) : ToJSONIfc

ScheduleItemData

@Serializable

data class ScheduleItemData(val name: String, var startTime: Double = 0.0, var duration: Double, var priority: Int = KSLEvent.DEFAULT_PRIORITY - 4, var message: String? = null, var datum: Double? = null)

ScheduleListener

class ScheduleListener : ScheduleChangeListenerIfc

Functions

main

fun main()