IMsMetaModelVisualController.GetVariableByFactor

Fore Syntax

GetVariableByFactor(RubricatorKey: Integer;
                    FactorKey: Integer;
                    GraphMeta: String;
                    Var VariableExists: Boolean;
                    [ParentKey: Integer = -1]): IMsCalculationChainVariable;

Fore.NET Syntax

GetVariableByFactor(RubricatorKey: uinteger;
                    FactorKey: uinteger;
                    GraphMeta: string;
                    var VariableExists: boolean;
                    ParentKey: uinteger): Prognoz.Platform.Interop.Ms.IMsCalculationChainVariable;

Parameters

RubricatorKey. Time series database key

FactorKey. Key of the series.

GraphMeta. Graphical context.

VariableExists. The attribute of the fact that the variable corresponding to the specified series exists in the internal time series database. It is returned after executing the method

ParentKey. Parent element key.

Description

The GetVariableByFactor method returns the variable corresponding to the series from the specified time series database.

Comments

The GraphMeta parameter can take the Null value.

Available values of the VariableExists parameter:

True. The variable exists in internal time series database
False. The variable is absent in time series database.

If the ParentKey parameter is set to -1, the variable is in the time series database root.

Fore and Fore.NET Examples

The method use is given in the example for IMsMetaModelVisualController.HasVariableRubricator.