SpaDES (version 1.1.4)

currentModule,.simList-method: 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. ll{ events Scheduled simulation events (the event queue). completed Completed simulation events. }

Usage

## S3 method for class '.simList':
currentModule(object)
events(object, unit)
## S3 method for class '.simList,character':
events(object, unit)
## S3 method for class '.simList,missing':
events(object, unit)
events(object) <- value
## S3 method for class '.simList':
events(object) <- value
current(object, unit)
## S3 method for class '.simList,character':
current(object, unit)
## S3 method for class '.simList,missing':
current(object, unit)
current(object) <- value
## S3 method for class '.simList':
current(object) <- value
completed(object, unit)
## S3 method for class '.simList,character':
completed(object, unit)
## S3 method for class '.simList,missing':
completed(object, unit)
completed(object) <- value
## S3 method for class '.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

simList-class, simList-accessors-envir, simList-accessors-inout, simList-accessors-modules, simList-accessors-objects, simList-accessors-params, simList-accessors-paths, simList-accessors-times.