openmi.om.timeSeriesInput: The base class for timeseries meta-model components.

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

The base class for timeseries meta-model components.

Description

The base class for timeseries meta-model components.

The base class for timeseries meta-model components.

Value

reference class of type openmi.om.timeSeriesInput

Super classes

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

Public fields

tsvalues

holds the timeseries data

intmethod

describes how to handle when current time does not match table exactly

intflag

0 - always interpolate, 1 - never interpolate, 2 - interpolate up to a distance of ilimit seconds

ilimit

interpolation/extrapolation limit

tscols

fields in source timeseries dataset

Methods

Public methods

• openmi.om.timeSeriesInput$init()

• openmi.om.timeSeriesInput$set_names()

• openmi.om.timeSeriesInput$getInputs()

• openmi.om.timeSeriesInput$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$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_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$update()

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

---

Method init()

init sets up for viewing or run

Usage

openmi.om.timeSeriesInput$init()

Returns

NULL

---

Method set_names()

set_names sets up tscols from timeseries source

Usage

openmi.om.timeSeriesInput$set_names()

Returns

NULL

---

Method getInputs()

add timeseries values to the data array

Usage

openmi.om.timeSeriesInput$getInputs()

Returns

NULL

---

Method clone()

The objects of this class are cloneable with this method.

Usage

openmi.om.timeSeriesInput$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.