IMsModel

Assembly: Ms;

Namespace: Prognoz.Platform.Interop.Ms;

Description

The IMsModel interface contains properties and methods of the Model modeling container object.

Inheritance Hierarchy

          INamedEntity

          IVirtualMetaObject

          IValidationFilterModel

          IMsModel

Comments

A model is used to calculate output variables by performing transformations on input variables using statistical and mathematical methods. Calculations are made taking into account the calendar frequency of the model (years, half-years, quarters, months and days).

Properties

  Property name Brief description

AttributeFormulasList

The AttributeFormulasList property returns the collection of methods for calculating additional attributes by formulas.

AutoName

The AutoName property determines whether to generate the model name automatically.

CalculationPeriod

The CalculationPeriod property determines formula actual period.

Chart

The Chart property returns a model chart.

ForecastEndDate

Outdated. Use IMsFormulaTransform.Period.

ForecastStartDate

Outdated. Use IMsFormulaTransform.Period.

IdentificationEndDate

Outdated. Use IMsFormulaTransform.Period.

IdentificationStartDate

Outdated. Use IMsFormulaTransform.Period.

Input

Outdated. Use Transform.Inputs.

IsExclusive

The IsExclusive property determines whether the model is internal for the calculation chain.

Kind

Outdated. Use Transform.Kind.

Output

Outdated. Use Transform.Outputs.

OutputPeriod

Outdated. Use Transform.OutputPeriod.

Period

Outdated. use IMsFormulaTransform.Period.

SaveZeros

The SaveZeros property determines whether zero values obtained on model calculation should be saved.

Series

Outdated. Use Transform.Series.

Stochastic

The Stochastic property returns True if the stochastic methods are used for model calculation.

Transform

The Transform property returns an object that enables the user to set up model parameters.

TreatNullsAsZeros

The TreatNullsAsZeros property determines whether to replace empty values with zeroes on model calculation.

UseAutoPeriod

The UseAutoPeriod property returns whether conditions are used to calculate start and end dates for sample and forecasting periods.

UseExistingData

The UseExistingData property determines whether all actual data of input variables is used on model calculation.

UseModelPeriod

The UseModelPeriod property determines whether model sample and forecasting periods should be used on problem calculation.

Properties inherited from IValidationFilterModel

  Property name Brief description

Settings

The Settings property returns validation settings.

Properties inherited from IVirtualMetaObject

  Property name Brief description

Description

The Description property determines object description.

MetabaseObject

The MetabaseObject property determines a repository object that stores an object.

Properties inherited from INamedEntity

  Property name Brief description
Id The Id property determines the object identifier.
Key The Key property returns the object key.
Name The Name property determines the object name.

Methods

  Method name Brief description

CreateCalculation

The CreateCalculation method creates an object that contains settings required for model calculation.

CreateStringGenerator

The CreateStringGenerator method creates generator of string model view.

Execute

The Execute method executes the model.

ReplaceOutputVariable

The ReplaceOutputVariable method replaces output variable.

RestoreLaner

The RestoreLaner method restores workspace of time series database from a model.

See also:

Ms Assembly Interfaces