Get properties of model components

Share:

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.

  • For Class it is one of SUBMODEL VARIABLE COMPARTMENT FLOW CONDITION CREATION REPRODUCTION IMMIGRATION LOSS ALARM EVENT SQUIRT STATE

  • For Type: one of VALUELESS REAL INTEGER FLAG EXTERNAL or ENUM(n), where n is the index of a set of enumerated type values.

  • For Eval: one of EXOGENOUS DERIVED TABLE INPUT SPLIT GHOST. Fixed parameters have TABLE and variable parameters INPUT for this property.

  • For Dims it is a list containing integers or the special types RECORDS MEMBERS SEPARATE START_VM END_VM for components in submodels without a preset member count.

  • For MinVal and MaxVal it is a number of the same type as the component.

  • For Desc and Comment it is a character string.

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