ITsCompositeFormulaTerm.Included

Fore syntax

Included: Boolean;

Fore.NET syntax

Included: boolean;

Description

The Included property determines whether the composite element is used to calculate expression.

Comments

Available values:

True. This element is used to calculate expression.
False. This element is not used to calculate expression.

Fore example

Executing the example requires a form with the following components:

The LanerBox with the LanerBox1 identifier.
The LanerResultsBox with the LanerResultsBox1 identifier.
The UiErAnalyzer which is the data source for LanerBox and LanerResultsBox.

Workbook of time series database must be loaded to UiErAnalyzer. Add links to the Transform and Ms system assemblies.

Before executing the example the workbook must contain only one selected series calculated by the linear regression method.

Sub UserProc;
Var
    Results: ILanerResultsBoxResults;
    Coefficients: ILanerResultsBoxCoefficients;
    i: Integer;
    FactorTerm: ITsCompositeFormulaTerm;
    LSerie: ILanerSerie;
Begin
    Results := LanerResultsBox1.Results;
    Coefficients := Results.Coefficients;
    For i := 0 To Coefficients.TermCount - 1 Do
        FactorTerm := Coefficients.FactorTerm(i);
        If FactorTerm.Included Then
            (FactorTerm As IMsCompositeFormulaTerm).ChangeLag(2);
        End If;
    End For;
    LSerie := LanerBox1.SelectedSeries(0);
    (LSerie As ILanerCalculateSerie).RefreshData;
End Sub UserProc;

After executing the example he lag is to be changed for linear regression factors used in calculation. Linear regression is to be recalculated.

Fore.NET example

Executing the example requires a form with the following components:

The LanerBoxNet with the LanerBoxNet1 identifier.
The LanerResultBoxNet with the LanerResultBoxNet1 identifier.
The UiErAnalyzerNet which is the data source for LanerBoxNet and LanerResultBoxNet.

Workbook of time series data base must be loaded to UiErAnalyzerNet. Add links to the Transform and Ms system assemblies.

Before executing the example the workbook must contain only one selected series calculated by the linear regression method.

Imports Prognoz.Platform.Interop.Transform;
Imports Prognoz.Platform.Interop.Express;
Imports Prognoz.Platform.Interop.Laner;
Imports Prognoz.Platform.Interop.Ms;
…
Public Sub UserProc();
Var
    Results: ILanerResultsBoxResults;
    Coefficients: ILanerResultsBoxCoefficients;
    i: Integer;
    FactorTerm: ITsCompositeFormulaTerm;
    LSerie: ILanerSerie;
Begin
    Results := LanerResultBoxNet1.CtrlBox.Results;
    Coefficients := Results.Coefficients;
    For i := 0 To Coefficients.TermCount - 1 Do
        FactorTerm := Coefficients.FactorTerm[i];
        If FactorTerm.Included Then
            (FactorTerm As IMsCompositeFormulaTerm).ChangeLag(2);
        End If;
    End For;
    LSerie := LanerBoxNet1.SelectedSeries[0];
    (LSerie As ILanerCalculateSerie).RefreshData();
End Sub

After executing the example he lag is to be changed for linear regression factors used in calculation. Linear regression is to be recalculated.