Learn R Programming

SpaDES.core (version 2.0.5)

emptyEventList: Blank (template) event list

Description

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

Usage

.emptyEventListDT

.singleEventListDT

.emptyEventList(eventTime, moduleName, eventType, eventPriority)

# S4 method for numeric,character,character,numeric .emptyEventList(eventTime, moduleName, eventType, eventPriority)

# S4 method for missing,missing,missing,missing .emptyEventList()

.emptyEventListCols

Value

Returns an empty event list.

Format

An object of class data.table (inherits from data.frame) with 0 rows and 4 columns.

An object of class data.table (inherits from data.frame) with 1 rows and 4 columns.

An object of class character of length 4.

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.

Author

Alex Chubaty

Details

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

eventTimeThe time the event is to occur.
moduleNameThe module from which the event is taken.
eventTypeA character string for the programmer-defined event type.
eventPriorityThe priority given to the event.