CapacityScheduleCIfc

Properties

Link copied to clipboard

The data associated with the capacity schedule

Link copied to clipboard
abstract val eventPriority: Int
Link copied to clipboard
abstract var initialStartTime: Double

The time from the beginning of the replication to the time that the schedule is to start

Link copied to clipboard
abstract var isAutoStartFlag: Boolean

Indicates whether the schedule should be started automatically upon initialization, default is true

Link copied to clipboard
abstract val isEmpty: Boolean

Checks if there are no items on the schedule

Link copied to clipboard
Link copied to clipboard

The schedule repeat flag controls whether the entire schedule will repeat after its entire duration has elapsed. The default is to repeat the schedule. The use of this flag only makes sense if a finite schedule length is specified

Link copied to clipboard
abstract val items: List<CapacityItemData>

The capacity schedule item data as a list

Functions

Link copied to clipboard

The same listener cannot be added more than once. Listeners are notified of schedule changes in the sequence by which they were added.

Link copied to clipboard
abstract fun addItem(capacity: Int, duration: Double, itemPriority: Int = eventPriority): CapacitySchedule.CapacityItem

Adds an item to the schedule. Each item is added consecutively to the schedule in the order added. The start time of the 2nd capacity change is the ending time of the first capacity change and so on.

Link copied to clipboard

Allow the creation of capacity schedule items via a data class

Link copied to clipboard
abstract fun clearSchedule()

Removes all capacity items from the schedule

Link copied to clipboard

Uses the supplied JSON string to configure the schedule via CapacityScheduleData

Link copied to clipboard
Link copied to clipboard

Returns the current settings in the form of the data type that can be serialized.

Link copied to clipboard

Deletes all listeners

Link copied to clipboard
open override fun settingsToJson(): String

Converts the configuration settings to JSON