get.model.property: Get properties of model components

Description Usage Arguments Value Author(s) Examples

View source: R/clientmmii.R

Description

This function can return any of several pieces of static information about a component in a loaded Simile model

Usage

1
get.model.property(model.handle,caption.path,requested.property)

Arguments

model.handle

Model handle created when calling load.model()

caption.path

Path made from submodel and component captions separated by forward slashes, like a member of the list returned by list.objects()

requested.property

One of the following strings:

Class

Returns the component class, i.e., which Simile symbol it is.

Type

Data type of component's value.

Eval

Source of component's value.

Dims

Returns list of the component value's array dimensions.

MinVal, MaxVal, Desc, Comment

Return other values or text associated with component in Simile.

Value

Form of returned value depends on the requested.property as described above.

Author(s)

Jasper Taylor

Examples

1
2
3
4
get.model.property("dummy_mh","/sector/output","Class")
# [1] "COMPARTMENT"
get.model.property("dummy_mh","/sector/output","Dims")
# [1] 2 5

Simile documentation built on May 29, 2017, 8:39 p.m.

Search within the Simile package
Search all R packages, documentation and source code