openmi.om.matrix: The base class for matrix/lokup table meta-model components.

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

The base class for matrix/lokup table meta-model components.

Description

The base class for matrix/lokup table meta-model components.

The base class for matrix/lokup table meta-model components.

Value

R6 class of type openmi.om.matrix

Super classes

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

Public fields

datamatrix

holds the actual table

colindex

holds the column lookup variable name (ustabe keycol1)

rowindex

holds the column lookup variable name (ustabe keycol2)

coltype

holds the column lookup type (ustabe lutype1)

rowtype

holds the row lookup type (ustabe lutype2)

Methods

Public methods

• openmi.om.matrix$set_prop()

• openmi.om.matrix$parse_class_specific()

• openmi.om.matrix$update()

• openmi.om.matrix$findMatch()

• openmi.om.matrix$exactMatch()

• openmi.om.matrix$interpolate()

• openmi.om.matrix$stairStep()

• openmi.om.matrix$window()

• openmi.om.matrix$closest()

• openmi.om.matrix$init()

• openmi.om.matrix$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$initialize()

• 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_openmi()

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

• 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 set_prop()

Usage

openmi.om.matrix$set_prop(propname, propvalue, format = "raw")

Arguments

propname

which attribute

propvalue

what value

format

of propvalue

Returns

NA

---

Method parse_class_specific()

Usage

openmi.om.matrix$parse_class_specific(propvalue)

Arguments

propvalue

from some custom classformat reading implementation

Returns

a settable data value

---

Method update()

update does the lookup

Usage

openmi.om.matrix$update()

Returns

NULL

---

Method findMatch()

findMatch looks into a single dimension table

Usage

openmi.om.matrix$findMatch(dm, ixval, ixtype = 0)

Arguments

dm

array to search

ixval

key to search for

ixtype

what kind of lookup to perform?

Returns

matching value (with interpolation if ixtype allows it)

---

Method exactMatch()

exactMatch looks for keys

Usage

openmi.om.matrix$exactMatch(dm, ixval, rectype = "row")

Arguments

dm

array to search

ixval

key to search for

rectype

what kind of array is dm?

Returns

matching value

---

Method interpolate()

interpolate searches by key and calculates if no exact match

Usage

openmi.om.matrix$interpolate(dm, ixval)

Arguments

dm

array to search

ixval

key to search for

Returns

interpolated value

---

Method stairStep()

stairStep searches by key and select closest previous

Usage

openmi.om.matrix$stairStep(dm, ixval)

Arguments

dm

array to search

ixval

key to search for

Returns

closest value

---

Method window()

window does what???

Usage

openmi.om.matrix$window(dm, ixval, ixoff)

Arguments

dm

array to search

ixval

key to search for

ixoff

index offset

Returns

calculated value

---

Method closest()

closest select closest value

Usage

openmi.om.matrix$closest(dm, ixval)

Arguments

dm

array to search

ixval

key to search for

Returns

closest value

---

Method init()

init sets up for viewing or run

Usage

openmi.om.matrix$init()

Returns

NULL

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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

Arguments

deep

Whether to make a deep clone.

Examples

NA

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