openmi.om.timer: The base time-keeping class for simulation control

In HARPgroup/openmi-om: Implementation of the OpenMI Concepts for Building Object-oriented Meta-models

The base time-keeping class for simulation control

Description

Class providing the minimum attributes and methods for a model component

Details

Has standard methods for iterating through timesteps and connecting with other components

Value

R6 class of type openmi.om.timer

Public fields

starttime

beginning of simulation

endtime

end of simulation

thistime

current simulation time

status

is this timer running, paused, finished

mo

current simulation month

da

current simulation day

yr

current simulation year

tz

current timezone

dt

time step

Methods

Public methods

• openmi.om.timer$update()

• openmi.om.timer$init()

• openmi.om.timer$clone()

---

Method update()

advance timer one timestep and update data

Usage

openmi.om.timer$update()

Returns

NULL

---

Method init()

initialize for a model run

Usage

openmi.om.timer$init()

Returns

NULL

---

Method clone()

The objects of this class are cloneable with this method.

Usage

openmi.om.timer$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

HARPgroup/openmi-om documentation built on March 4, 2023, 6:56 p.m.