Learn R Programming
SpaDES (version 1.1.4)

.emptyEventList: Blank (template) event list

Description

Internal function called from spades, returning an empty event list.

Usage

.emptyEventList(eventTime, moduleName, eventType, eventPriority)
## S3 method for class 'numeric,character,character,numeric':
.emptyEventList(eventTime,
  moduleName, eventType, eventPriority)
## S3 method for class 'missing,missing,missing,missing':
.emptyEventList()
.emptyEventListCols
.emptyEventListObj
.emptyEventListNA

Arguments

eventTime
The time the event is to occur.
moduleName
The module from which the event is taken.
eventType
A character string for the programmer-defined event type.
eventPriority
The priority given to the event.

Value

  • Returns an empty event list.

format

An object of class character of length 4.

Details

Event lists are sorted (keyed) first by time, second by priority. Each event is represented by a data.table row consisting of: ll{ eventTime The time the event is to occur. moduleName The module from which the event is taken. eventType A character string for the programmer-defined event type. eventPriority The priority given to the event. }