SpaDES (version 1.3.1)

events: Simulation event lists

Description

Accessor functions for the events and completed slots of a simList object. By default, the event lists are shown when the simList object is printed, thus most users will not require direct use of these methods.

events	Scheduled simulation events (the event queue).
completed	Completed simulation events.

Usage

events(object, unit)
# S4 method for .simList,character
events(object, unit)
# S4 method for .simList,missing
events(object, unit)
events(object) <- value
# S4 method for .simList
events(object) <- value
current(object, unit)
# S4 method for .simList,character
current(object, unit)
# S4 method for .simList,missing
current(object, unit)
current(object) <- value
# S4 method for .simList
current(object) <- value
completed(object, unit)
# S4 method for .simList,character
completed(object, unit)
# S4 method for .simList,missing
completed(object, unit)
completed(object) <- value
# S4 method for .simList
completed(object) <- value

Arguments

object

A simList simulation object.

unit

Character. One of the time units used in SpaDES.

value

The object to be stored at the slot.

Value

Returns or sets the value of the slot from the simList object.

Details

Currently, only get and set methods are defined. Subset methods are not.

See Also

SpaDES, specifically the section 1.2.6 on Simulation event queues.

Other functions to access elements of a simList object: .addDepends, doEvent.checkpoint, envir, globals, inputs, ls.simList, ls.str.simList, modules, objs, packages, params, paths, progressInterval, times