Подключение пользовательских функций

Пользовательские функции и методы позволяют расширить возможности выражения за счёт использования пользовательских методик расчёта. Пользовательские функции доступны для использования в:

По умолчанию пользовательские функции не подключены к инструментам и для их использования их каждый раз надо вводить в выражение вручную. Продукт «Форсайт. Аналитическая платформа» позволяет подключить пользовательские функции к системным функциям одновременно во всех вышеперечисленных инструментах.

Примечание. Подключение пользовательских функций доступно только в настольном приложении.

Например, в редакторе выражения они будут отображаться на панели функций в категории «Пользовательские функции»:

Для подключения пользовательских функций используйте вкладку «Методы» в разделе «Пользовательские метаданные» диалога «Параметры». Все методы, добавленные на данной вкладке, будут подключены в раздел пользовательских функций в инструментах продукта «Форсайт. Аналитическая платформа».

Перейдите в навигатор объектов.
Выполните команду «Сервис > Параметры» в главном меню.
Будет открыт диалог «Параметры». В левой части диалога выберите пункт «Пользовательские метаданные».
Перейдите на вкладку «Методы».

На вкладке содержатся пользовательские функции, разделённые по папкам. Папки - это категории, предназначенные для упорядочения и группировки функций. Пользовательские функции, сгруппированные по категориям, отображаются в инструментах «Анализ временных рядов» и «Моделирование и прогнозирование». В редакторе выражения и в инструментах «Алгоритмы расчёта» и «Отчёты» пользовательские функции отображаются без разделения на категории.

Требования, предъявляемые к пользовательским функциям:

Для добавления категории выполните команду:

«Категория» в раскрывающемся меню кнопки «Добавить»;
«Добавить категорию» в контекстном меню списка методов.

Категория будет добавлена на вкладку «Методы». Название категории будет находиться в режиме редактирования. Введите название категории и нажмите клавишу ENTER.

Обратите внимание, что категория не может быть добавлена в другую категорию.

Для добавления и настройки метода:

Выберите категорию, в которую будет добавлен метод. Если не выбрана ни одна из категорий, то метод будет добавлен без категории.
Добавьте метод. Для этого:

нажмите кнопку «Добавить»;
выполните команду «Метод» в раскрывающемся меню кнопки «Добавить»;
выполните команду «Добавить метод» в контекстном меню списка методов.

Метод будет добавлен в выбранную категорию на вкладке «Методы». Название метода будет находиться в режиме редактирования. Введите название метода и нажмите клавишу ENTER.
В раскрывающемся списке «Сборка, модуль или форма» выберите форму, модуль Fore, сборку Fore или сборку Fore.NET, содержащую реализацию метода.
В раскрывающемся списке «Метод» выберите процедуру или функцию, реализующую метод. В списке будут содержаться все доступные процедуры и функции из объекта, выбранного в списке «Сборка, модуль или форма».
В списке «Тип» укажите тип метода:

Арифметический. Используется по умолчанию. Применяется для вычисления одиночных значений;
Поточечный. Расчёт производится индивидуально в каждой точке ряда данных;
Векторный. Расчёт производится для ряда данных целиком.

Обратите внимание, что тип метода используется для его классификации, а не для определения режима расчёта метода. Режим расчёта определён заранее и зависит от используемого инструмента.

Примечание. В инструменте «Моделирование и прогнозирование» будут доступны только векторные методы.

В поле «Описание» дайте краткое описание метода, которое будет видеть пользователь. Описание отображается в редакторе выражения, мастере функций в инструменте «Отчёты» и редакторе формул в инструменте «Алгоритмы расчёта».
Если метод параметрический, то доступна настройка параметров метода. Для этого нажмите кнопку «Параметры». Если кнопка недоступна, то метод непараметрический.

Будет открыто окно «Параметры»:

В окне содержится список всех параметров метода. Для настройки параметра:

Выберите параметр в списке. В поле «Тип данных» будет отображён тип данных параметра, указанный в методе. Изменить тип данных параметра нельзя.
В поле «Значение» задайте значение параметра по умолчанию. Тип данных указанного значения должен совпадать с типом данных параметра.
Если при создании метода для параметра было задано значение по умолчанию, то оно будет отображено в поле «Значение». Это значение может быть изменено.
В поле «Описание» дайте краткое описание параметра, которое буде видеть пользователь. Описание отображается в редакторе выражения, мастере функций в инструменте «Отчёты» и редакторе формул в инструменте «Алгоритмы расчёта».

В результате будет добавлен и настроен метод.

Примечание. Для подключения пользовательской функции с помощью языка Fore используйте метод IForeMethods.Add.

Для редактирования метода выделите его в списке. Настройки метода будут отображены в соответствующих полях. Измените требуемые значения.

Для переименования выделенного метода или категории:

нажмите клавишу F2;
выполните команду «Переименовать» в контекстном меню;
щёлкните по методу или категории.

Название будет переведено в режим редактирования. Введите новое название метода или категории и нажмите клавишу ENTER.

Для настройки порядка следования выделенного метода или категории:

используйте кнопки и ;
перетащите метод или категорию выше или ниже по списку. Используйте данный способ для изменения категории метода.

Обратите внимание, что категория не может быть перемещена во внутрь другой категории.

Для удаления выделенного метода или категории:

нажмите кнопку «Удалить»;
выполните команду «Удалить» в контекстном меню;
нажмите сочетание клавиш CTRL+DLETE.

Будет отображен запрос подтверждения выполняемого действия. При положительном ответе метод или категория будут удалены. Если внутри категории содержались методы, то они будут оставлены и перемещены в список методов без категории.

Пример синтаксиса пользовательской функции

В качестве пользовательской функции можно использовать и функции, и методы.

Sub MyFunc(Factor1, Factor2: ITimeSeries; Var Output: ITimeSeries; Coef1: Double; Coef2: Double);
Begin
...
End Sub MyFunc;

Public Shared Sub MyFunc(Factor1, Factor2: ITimeSeries; Var Output: ITimeSeries; Coef1: Double; Coef2: Double);
Begin
...
End Sub;

Function MyFunc(Input, Input1: ITimeSeries; Coef: Double): ITimeSeries;
Var
    Output: ITimeSeries;
Begin
    ...
    Return Output;
End Function MyFunc;

Public Shared Function MyFunc(Input, Input1: ITimeSeries; Coef: Double): ITimeSeries:
Var
    Output: ITimeSeries;
Begin
    ...
    Return Output;
End Function;