GetMs

Syntax

GetMsResult GetMs(MsId tMs, GetMsArg tArg)

Parameters

tMs. Opened modeling container instance moniker.

tArg. Operation execution parameters.

Description

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

Comments

The operation enables the user to:

• Create new objects in modeling container.

• Get object data and metadata.

• Execute various operations with objects, for example, calculate equations of models, get calculated data, and so on.

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

• Specify the pattern in the tArg.pattern field, according to which metadata is extracted.

• Specify the filter in the tArg.filter field, according to which only the objects are selected that will be used in further work.

• Specify execution parameters of operations in the tArg.execParams field that must be executed with modeling container object. The object is specified in the tArg.pattern.Item field.

Operation execution 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