currentModule,.simList-method

0th

Percentile

Simulation event lists

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
"currentModule"(object)
events(object, unit)
"events"(object, unit)
"events"(object, unit)
events(object) <- value
"events"(object) <- value
current(object, unit)
"current"(object, unit)
"current"(object, unit)
current(object) <- value
"current"(object) <- value
completed(object, unit)
"completed"(object, unit)
"completed"(object, unit)
completed(object) <- value
"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.
Details

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

Value

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

Note

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.

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.

Aliases
  • completed
  • completed,.simList,character-method
  • completed,.simList,missing-method
  • completed<-
  • completed<-,.simList-method
  • current
  • current,.simList,character-method
  • current,.simList,missing-method
  • current<-
  • current<-,.simList-method
  • currentModule,.simList-method
  • events
  • events,.simList,character-method
  • events,.simList,missing-method
  • events<-
  • events<-,.simList-method
  • simList-accessors-events
Documentation reproduced from package SpaDES, version 1.2.0, License: GPL-3

Community examples

Looks like there are no examples yet.