SpaDES (version 1.3.1)

.emptyEventList: Blank (template) event list

Description

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

Usage

.emptyEventList(eventTime, moduleName, eventType, eventPriority)
.emptyEventListDT
.singleEventListDT
# S4 method for numeric,character,character,numeric
.emptyEventList(eventTime,
  moduleName, eventType, eventPriority)
# S4 method for 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 data.table (inherits from data.frame) with 0 rows and 4 columns.

Details

Event lists are sorted (keyed) first by time, second by priority. Each event is represented by a data.table row consisting of:

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.