openmi.om.runtimeController: The base class for meta-model simulation control.

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

The base class for meta-model simulation control.

Description

Class providing a runnable model controller

Details

Will iterate through time steps from model timer start to end time, executing all child components

Value

R6 class of type openmi.om.runtimeController

Super classes

openmi.om::openmi.om.base -> openmi.om::openmi.om.linkableComponent -> openmi.om.runtimeController

Methods

Public methods

• openmi.om.runtimeController$new()

• openmi.om.runtimeController$checkRunVars()

• openmi.om.runtimeController$run()

• openmi.om.runtimeController$update()

• openmi.om.runtimeController$init()

• openmi.om.runtimeController$clone()

Inherited methods

• openmi.om::openmi.om.base$addComponent()

• openmi.om::openmi.om.base$addInput()

• openmi.om::openmi.om.base$add_component()

• openmi.om::openmi.om.base$asJSON()

• openmi.om::openmi.om.base$finish()

• openmi.om::openmi.om.base$getInputs()

• openmi.om::openmi.om.base$getValue()

• openmi.om::openmi.om.base$get_component_id()

• openmi.om::openmi.om.base$logState()

• openmi.om::openmi.om.base$log_debug()

• openmi.om::openmi.om.base$orderOperations()

• openmi.om::openmi.om.base$parse_class_specific()

• openmi.om::openmi.om.base$parse_openmi()

• openmi.om::openmi.om.base$prepare()

• openmi.om::openmi.om.base$set_prop()

• openmi.om::openmi.om.base$set_sub_prop()

• openmi.om::openmi.om.base$set_vars()

• openmi.om::openmi.om.base$settable()

• openmi.om::openmi.om.base$step()

• openmi.om::openmi.om.base$stepChildren()

• openmi.om::openmi.om.base$validate()

---

Method new()

create controller

Usage

openmi.om.runtimeController$new()

Returns

R6 class

---

Method checkRunVars()

Usage

openmi.om.runtimeController$checkRunVars()

Returns

boolean if model variables are sufficient to run

---

Method run()

Usage

openmi.om.runtimeController$run()

Returns

NA

---

Method update()

Usage

openmi.om.runtimeController$update()

Returns

NA

---

Method init()

Usage

openmi.om.runtimeController$init()

Returns

NA

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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

Arguments

deep

Whether to make a deep clone.

See Also

NA

Examples

NA

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