Generic: Generic class

In dymium-org/dymiumCore: A Toolkit for Building a Dynamic Microsimulation Model for Integrated Urban Modelling

Description

Can be used as a template for other objects. This contains useful utility functions for abstraction objects. See the public members (methods).

Format

R6::R6Class object.

Construction

Obj <- Generic$new(...)

Fields

• NULL

Methods

• debug()
  () -> self & private
  Makes debugging the object easier by assigning self and private to the global environment of the current seesion.

• log(desc, value, tag = "", time = .get_sim_time(), .lg = parent.frame()[["lg"]])
  (character(1), any objects, character(1), integer(1), lgr::Logger)
  For logging simulation outcomes to private$.log. get_log(x) can be used to extract the log data from any object that inherit Generic. Note that, the logger in log can be specified. By default, it tries to look in the parent.frame the calling scope to find a logger named lg which is the default name used in dymium modules. If not found, then it will automatically use dymiumCore's logger.

• is_dymium_class()
  Returns TRUE. Use for internal checking.

Private field

• .log
  A data.table for storing logs. There are 6 columns: time (integer), created_timestamp(integer), class (character), tag (character), desc (character), value (list). The value column is a list column gives it a flexibility to store any types of objects.

dymium-org/dymiumCore documentation built on July 18, 2021, 5:10 p.m.