API «КАСКАД Цифра» (Application Programming Interface — интерфейс программирования приложений) предлагает ряд функций, добавляющих специальных менеджеров к системе управления процессами. Менеджер — это программа, которая взаимодействует с системой по протоколу, определенному «КАСКАД Цифра».

ПРИМЕЧАНИЕ Пожалуйста, учитывайте требования к разработке API при создании пользовательских компонентов.

Документация по API

Документацию по функциям API можно найти в каталоге вашей установки

<путь_КАСКАД>/api/docu

ПРИМЕЧАНИЕ Документация доступна только в том случае, если в настройках «КАСКАД Цифра» была выбрана опция установки API.

Классы, подключение из файлов

Для того чтобы облегчить работу с большим количеством классов C++, доступных в «КАСКАД Цифра», все подключаемые файлы называются точно так же, как и имя класса, но имеют расширение «.hxx». Например, класс под названием «ManagerIdentifier» можно найти в файле «ManagerIdentifier.hxx». То есть, для использования класса необходимо включить соответствующий файл с помощью директивы #include.

Многие классы можно использовать и без явного #include, т.к., например, файл Manager.hxx уже включает множество других классов.

Менеджер событий и данных

Один из основных менеджеров в «КАСКАД Цифра» — менеджер событий. Он является центром коммуникаций системы управления и как только любой другой менеджер загружается, начинается обмен сообщениями с менеджером событий.

Второй ключевой менеджер — это Менеджер данных, т.к. он выполняет все задачи по управлению данными. При запуске программы каждый менеджер подключается к Менеджеру данных для инициализации. После успешной инициализации программа подключается к Менеджеру событий (за исключением, конечно, самого Менеджера событий). Соединения с менеджером данных и менеджером событий поддерживаются до тех пор, пока работа текущего менеджера не будет завершена.

Программа может подключиться к менеджерам данных и событий только в том случае, если нет другого подключенного менеджера с тем же идентификатором. Особенно при использовании менеджеров API убедитесь, что все они одного типа и отличаются только идентификационным номером.

ВНИМАНИЕ ВСЕГДА перекомпилируйте пользовательские менеджеры, созданные с помощью определенной версии «КАСКАД Цифра», при переходе к более поздней версии (это относится и к «branch» версиям!).

Сообщения

Менеджеры обмениваются информацией друг с другом с помощью сообщений. «КАСКАД Цифра» имеет фиксированный набор сообщений, используемых для связи.

Большинство функций API используются для генерации и отправки сообщений. Менеджеры получают сообщения с помощью функции doReceive(), которая применяется ко всем входящим сообщениям.

Файл заголовков FunctionVar

Так же в «КАСКАД Цифра» присутствует файл заголовков FunctionVar.hxx. Однако следует учитывать, что в этот файл также включены заголовки Qt, которые не входят в API «КАСКАД Цифра». Таким образом, необходима отдельная установка Qt.

Раздел	Описание
API, основы	Общий обзор и ссылки на разделы.
Установка API	Установка при работе с операционными системами NT и Linux.
Демонстрационная версия менеджера	В данном примере показано, как менеджер подключается к менеджерам данных и событий. Также он подключается к точке данных и каждый раз копирует новое значение в другую точку данных.
SampleDriver	В данном примере рассматривается драйвер ComDrv. Два драйвера обмениваются друг с другом информацией посредством «namedPipes».
Драйвер TCP	Это пример драйверов, которые обмениваются информацией посредством протокола TCP или UDP.
Сообщения API	Пока вы будете использовать задокументированные функции API, нет необходимости в тщательном знании сообщений: сообщения создаются и отправляются функциями интерфейса API, поэтому пользователю не приходится иметь с ними дело.
Классы менеджеров API	В данном разделе описываются основные классы, необходимые для разработки менеджера API.
Драйвер ComDrv	Общий драйвер является совокупностью классов, охватывающих функциональный диапазон, которым должен обладать каждый драйвер программы «КАСКАД Цифра». Также он определяет интерфейс для компонентов, относящихся к аппаратному обеспечению.
Панели конфигурирования для новых драйверов	Подготовлено два примерных сценария, чтобы упростить вам интегрирование новых драйверов в программу «КАСКАД Цифра». Все, что вам необходимо сделать, — это добавить имя и тип в указанных точках в сценариях, и определить свои команды.
EWO (объект внешнего виджета)	EWO (объект внешнего виджета) — это графический объект (виджет), который был создан сторонней организацией (заказчиком), и может быть встроен в любую панель «КАСКАД Цифра». Этот объект не зависит от платформы.