R/ModelObject.R

In MicroMoB: Discrete Time Simulation of Mosquito-Borne Pathogen Transmission

#' @title Make a model object
#' @description The model object is a hashed [environment]. By default it contains
#' a single list, `model$global` storing global state.
#' @param tmax number of days to simulate
#' @param p number of places
#' @param l number of aquatic habitats (optional, will be set to `p` by default)
#' @return an object of class [environment]
#' @export
make_MicroMoB <- function(tmax, p, l = p) {
  stopifnot(is.finite(tmax))
  stopifnot(tmax > 0)
  stopifnot(is.finite(p))
  stopifnot(p > 0)
  stopifnot(is.finite(l))
  stopifnot(l > 0)
  object <- structure(new.env(hash = TRUE), class = "MicroMoB")
  object$global <- list(tmax = as.integer(tmax), tnow = 1L, p = as.integer(p), l = as.integer(l))
  return(object)
}

#' @title Get current time of simulation from model object
#' @param model an object from [make_MicroMoB]
#' @export
get_tnow <- function(model) {
  stopifnot(inherits(model, "MicroMoB"))
  return(model$global$tnow)
}

#' @title Get maximum time of simulation from model object
#' @param model an object from [make_MicroMoB]
#' @export
get_tmax <- function(model) {
  stopifnot(inherits(model, "MicroMoB"))
  return(model$global$tmax)
}