openmi.om.equation: The base class for executable equation based meta-model...

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

The base class for executable equation based meta-model components.

Description

The base class for executable equation based meta-model components.

The base class for executable equation based meta-model components.

Value

reference class of type openmi.om.equation

Super classes

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

Public fields

equation

the text based un-parsed equation

eq

the ready to eval equation

defaultvalue

value to set if null

minvalue

minimum value to use if nonnegative = TRUE

nonnegative

should result be constrained to positive only?

numnull

counter of occurences of null evaluation for debugging

arithmetic_operators

operators to allow in equations

safe_envir

the set of values that are accessible to the equation during evaluation

Methods

Public methods

• openmi.om.equation$settable()

• openmi.om.equation$new()

• openmi.om.equation$get_operators()

• openmi.om.equation$set_prop()

• openmi.om.equation$init()

• openmi.om.equation$parse()

• openmi.om.equation$set_vars()

• openmi.om.equation$update()

• openmi.om.equation$evaluate()

• openmi.om.equation$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_sub_prop()

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

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

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

---

Method settable()

settable returns properties that can be set

Usage

openmi.om.equation$settable()

Returns

array c() of object property names

---

Method new()

create new instance of equation object

Usage

openmi.om.equation$new(elem_list = list(), format = "raw")

Arguments

elem_list

list of attributes to set on object

format

data format of elem_list

Returns

array c() of object property names

---

Method get_operators()

get_operators returns list of valid functions

Usage

openmi.om.equation$get_operators()

Returns

array c() of function names

---

Method set_prop()

Usage

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

Arguments

propname

which attribute

propvalue

what value

format

of propvalue

Returns

NA

---

Method init()

init sets up data, parses equation and then passes on to parent class

Usage

openmi.om.equation$init()

Returns

NULL

---

Method parse()

parse parses equation

Usage

openmi.om.equation$parse()

Returns

NULL

---

Method set_vars()

set_vars finds all the input var names for this function

Usage

openmi.om.equation$set_vars()

Returns

NULL

---

Method update()

update executes the parsed equation, sets object value prop

Usage

openmi.om.equation$update()

Returns

NULL

---

Method evaluate()

evaluate is called by update, but can also b called if calling routine wants the value returned

Usage

openmi.om.equation$evaluate()

Returns

value the result of the equation

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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