GetMs

Syntax

GetMsResult GetMs(MsId tMs, GetMsArg tArg)

Parameters

tMs. Opened modeling container instance moniker.

tArg. Operation execution parameters.

Description

The GetMs operation gets metadata of modeling container and its child objects.

Comments

The operation:

• Creates new objects in modeling container.

• Gets object data and metadata.

• Executes various operations with objects, for example, calculates equations of models, gets calculated data, and so on.

To execute the operation, in the tMs field specify modeling container moniker, and in the tArg field specify operation execution parameters:

• In the tArg.pattern field specify the pattern that will be used to get metadata.

• In the tArg.filter field specify the filter that will be used to select only the objects that will be used for further work.

• In the tArg.execParams field specify execution parameters for the operations that should be executed with a modeling container object. In the tArg.pattern.Item field specify the object itself.

The operation results in the requested metadata and execution results for the specified operations.

Example

Various methods of using the operation are given in the following examples:

• Creating objects:

• • Creating a Model.

  • Creating a Variable.

  • Creating a Variable Based on a Time Series Database Series.

  • Creating an Equation.

• Opening objects:

• • Opening Model.

  • Opening Metamodel.

• Equation calculation:

• • Calculating Equation.

  • Calculating the Extrapolate Method.

  • Calculating the Baxter-King Filter Method.

  • Calculating the Hodrick-Prescott Filter Method.

  • Calculating the Determinate Equation Method.

  • Calculating the Linear Regression Method.

  • Calculating the Non-Linear Regression Method.

• Models calculation:

• • Creating an Object for Model Calculation.

  • Step-by-Step Model Calculation.

  • Starting Model Calculation.

  • Suspending Model Calculation.

  • Resuming Model Calculation.

  • Stopping Model Calculation.

• Getting data:

• • Getting Variable Data.

  • Getting Equation Data.

  • Getting Model Data.

• Other examples:

• • Renaming Variable.

  • Retrieving Limited Number of Objects.

  • Searching for Model Factor by Data Slice.

  • Adding Variables to Model.

  • Deleting Equation.

See also:

Working with Modeling Container

Copy page URL

Back to top

To report a found bug, please, select the text with the bug and click Report a Bug or CTRL+ENTER.

Help system 10.5 of 04/10/2024, © FORESIGHT