ScheduleCIfc

Properties

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

the priority associated with the item's start event

Link copied to clipboard

The data associated with the schedule

Link copied to clipboard

The schedule item data as a list

Link copied to clipboard
abstract var scheduleLength: Double

Represents the total length of time of the schedule. The total of the durations added to the schedule cannot exceed this amount. After this time has elapsed the entire schedule can repeat if the schedule repeat flag is true. The default is infinite.

Link copied to clipboard
abstract var startEventPriority: Int

the priority associated with the schedule's start event

Functions

Link copied to clipboard
abstract fun addItem(scheduleItemData: ScheduleItemData): Schedule.ScheduleItem

Adds the item to the schedule

Link copied to clipboard
abstract fun addItems(items: List<ScheduleItemData>)

Adds all the items to the schedule.

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 clearSchedule()

Removes all schedule items from the schedule

Link copied to clipboard
open override fun configureFromJson(json: String): ScheduleData

Uses the supplied JSON string to configure the schedule via ScheduleData

Link copied to clipboard
abstract operator fun contains(listener: ScheduleChangeListenerIfc): Boolean
Link copied to clipboard
Link copied to clipboard
open override fun currentSettings(): ScheduleData

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
abstract fun removeItem(item: Schedule.ScheduleItem?)

Removes the item from the schedule. If the item is null or not on this schedule nothing happens.

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

Converts the configuration settings to JSON