обновление README

ntk-interface · Apr 22, 2024 · 0f023b7 · 0f023b7
1 parent edc63e8
commit 0f023b7
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 46 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,64 @@
+## Iface.Oik.SvgPlayground
+
+Программа для тестирования SVG-картинок, предназначенных для каталога документов ПО Клиент10 «ОИК Диспетчер НТ»
+
+Программа запускается на ОС Windows, требуется наличие установленного [.NET Desktop Runtime 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
+
+Программа не требует связи с сервером
+
+#### Примеры
+
+См. каталог samples
+
+#### Используемые функции
+
+```
+logMessage                        - вывести сообщение для отладки
+
+setElementProperty                - установить значение свойства элемента SVG
+getElementProperty                - получить значение свойства элемента SVG
+
+initTmStatus                      - инициализировать телесигнал
+initTmAnalog                      - инициализировать телеизмерение
+initVariable                      - инициализировать внутреннюю переменную схемы
+
+getTmStatusStatus                 - получить состояние сигнала (0 или 1)
+getTmStatusCaption                - получить текстовое состояние сигнала (типа вкл или откл)
+isTmStatusOn                      - является ли состояние сигнала включенным
+isTmStatusUnreliable              - является сигнал недостоверным
+isTmStatusMalfunction             - является ли состояние сигнала неиспранвым
+isTmStatusIntermediate            - является ли состояние сигнала промежуточным
+isTmStatusManuallySet             - является ли состояние сигнала установленным вручную
+isTmStatusManuallyBlocked         - является ли состояние сигнала заблокированным оператором
+isTmStatusAbnormal                - является ли состояние сигнала отклонением от нормы
+isTmStatusUnacked                 - является ли состояние сигнала неквитированным
+IsTmStatusUnderMaintenance        - является ли состояние сигнала ремонтным
+IsTmStatusUnderCheckup            - является ли состояние сигнала контрольным
+isTmStatusCustomFlagRaised        - взведен ли произвольный флаг сигнала (аргументом является номер флага от 1 до 4)
+GetTmStatusCustomFlagCaption      - получить текстовое состояние произвольного флага сигнала (аргументом является номер флага от 1 до 4)
+
+getTmAnalogValue                  - получить значение измерения в виде числа
+getTmAnalogUnit                   - получить единицу измерения
+getTmAnalogValueString            - получить значение измерения в виде строки (значение)
+getTmAnalogValueWithUnitString    - получить значение измерения в виде строки (значение + единица измерения)
+isTmAnalogUnreliable              - является ли значение измерения недостоверным
+isTmAnalogManuallySet             - является ли состояние измерения установленным вручную
+isTmAnalogManuallyBlocked         - является ли состояние измерения заблокированным оператором
+isTmAnalogAbnormal                - является ли состояние измерения отклонением от нормы
+isTmAnalogUnacked                 - является ли состояние измерения неквитированным
+isTmAnalogAlarmAlert              - является ли значение измерения со взведенной аварийной уставкой
+isTmAnalogAlarmWarning            - является ли значение измерения со взведенной предупредительной уставкой
+isTmAnalogCustomFlagRaised        - взведена ли уставка измерения (аргументом является номер важности от 1 до 4)
+
+isVariableOn                      - является ли состояние внутренней переменной включенным
+isVariableUnreliable              - является ли состояние внутренней переменной недостоверным
+isVariableManuallySet             - является ли состояние внутренней переменной установленным вручную
+setVariable                       - установить значение внутренней переменной
+setVariableUnreliable             - установить признак недостоверности внутренней переменной
+setVariableManuallySet            - установить значение ручной установки внутренней переменной
+
+initCustomToolTip                 - задать произвольный текст всплывающего окна при наведении на элемент
+initTmStatusDefaultCommands       - инициализировать команды по умолчанию для телесигнала
+initTmAnalogDefaultCommands       - инициализировать команды по умолчанию для телеизмерения
+initOpenDocumentDefaultCommands   - инициализировать команды по умолчанию для открытия документа
+```