SpaDES (version 1.1.4)

modules: Simulation modules and dependencies

Description

Accessor functions for the depends and modules slots in a simList object. These are included for advanced users. ll{ depends List of simulation module dependencies. (advanced) modules List of simulation modules to be loaded. (advanced) inputs List of loaded objects used in simulation. (advanced) }

.callingModuleName returns the name of the module that is currently the active module calling functions like scheduleEvent. This will only return the module name if it is inside a spades function call, i.e., it will return NULL if used in interactive mode. The related function currentModule is simply a rapid accessor for the current module name. This latter will return the module that is in the current event queue, which will never be NULL

Usage

modules(object)

## S3 method for class '.simList': modules(object)

modules(object) <- value

## S3 method for class '.simList': modules(object) <- value

depends(object)

## S3 method for class '.simList': depends(object)

depends(object) <- value

## S3 method for class '.simList': depends(object) <- value

.callingModuleName(object)

## S3 method for class '.simList': .callingModuleName(object)

currentModule(object)

Arguments

object
A simList simulation object.
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-events, simList-accessors-inout, simList-accessors-objects, simList-accessors-params, simList-accessors-paths, simList-accessors-times.