log_ {simmer}

Debugging

Description

Activities for displaying messages preceded by the simulation time and the name of the arrival, and for setting conditional breakpoints.

Usage

log_(.trj, message, level = 0, ..., tag)

stop_if(.trj, condition, ..., tag)

Arguments

.trj

the trajectory object.

message

the message to display, accepts either a string or a callable object (a function) which must return a string.

level

debugging level. The message will be printed if, and only if, the level provided is less or equal to the log_level defined in the simulation environment (see simmer).

...

unused.

tag

activity tag name to perform named rollbacks (see rollback) or just to better identify your activities.

condition

a boolean or a function returning a boolean.

Value

Returns the trajectory object.

Examples

## log levels
traj <- trajectory() %>%
  log_("this is always printed") %>% # level = 0 by default
  log_("this is printed if `log_level>=1`", level = 1) %>%
  log_("this is printed if `log_level>=2`", level = 2)

simmer() %>%
  add_generator("dummy", traj, at(0)) %>%
  run() %>% invisible

simmer(log_level = 1) %>%
  add_generator("dummy", traj, at(0)) %>%
  run() %>% invisible

simmer(log_level = Inf) %>%
  add_generator("dummy", traj, at(0)) %>%
  run() %>% invisible