Класс конвертера. Подробнее...
#include <ilg_cpp_helpers.h>
Открытые члены | |
| CConverter () | |
| Конструктор по умолчанию. | |
| CConverter (ilg_handle h) | |
| Конструктор класса из дескриптора конвертера. Подробнее... | |
| CConverter (CConverter &&other) | |
| Конструктор перемещения. Подробнее... | |
| virtual | ~CConverter () |
| Деструктор | |
| CConverter & | operator= (CConverter &&other) |
| Оператор перемещения | |
| void | SetMessageCallback (ilg_converter_message_callback pCallback, void *pUserData=nullptr) |
| Устанавливает функцию обратного вызова для уведомлений конвертера. Подробнее... | |
| void | EnableMessageQueue (bool fEnable=true) |
| Включает/выключает очередь сообщений. Подробнее... | |
| bool | GetMessage (ilg_converter_msg &nMsg, const void *&pMsgData) const |
| Извлекает следующее сообщение из очереди. Подробнее... | |
| void | SetOptions (const ilg_converter_options &rOptions) |
| Устанавливает параметры конвертера. Подробнее... | |
| void | GetOptions (ilg_converter_options &rOptions) const |
| Возвращает параметры конвертера. Подробнее... | |
| void | Connect (bool fReconnect=false) |
| Подключается к конвертеру. Подробнее... | |
| CAsyncCommand | Begin_Connect (bool fReconnect=false) |
| Запускает асинхронную команду подключения к конвертеру. Подробнее... | |
| void | Disconnect () |
| Отключается от конвертера. Подробнее... | |
| CAsyncCommand | Begin_Disconnect () |
| Запускает асинхронную команду отключения от конвертера. Подробнее... | |
| ilg_connection_status | GetConnectionStatus () const |
| Возвращает состояние подключения к конвертеру. Подробнее... | |
| void | GetConverterInfo (ilg_converter_info &rInfo) const |
| Возвращает информацию о конвертере. Подробнее... | |
| void | ReadLicenseInfo (ilg_license_info &rInfo, bool fForce=false) |
| Возвращает информацию о текущей лицензии конвертера. Подробнее... | |
| void | ReadLicenseInfo (uint32_t nLicenseN, ilg_license_info &rInfo) |
| Читает информацию о лицензии конвертера. Подробнее... | |
| CAsyncCommand | Begin_ReadLicenseInfo (uint32_t nLicenseN) |
| Запускает асинхронную команду запроса инфо о лицензии конвертера. Подробнее... | |
| size_t | GetLicenseCount () const |
| Возвращает количество установленных лицензий. Подробнее... | |
| CAsyncCommand | Begin_GetLicenseCount () const |
| Запускает асинхронную команду получения количества установленных лицензий. Подробнее... | |
| void | GetLicenseInfo (size_t nIdx, ilg_license_info &rInfo) const |
| Возвращает инфо о лицензии из списка, полученного методом GetLicenseCount. Подробнее... | |
| void | WriteLicense (const void *pData, size_t nSize) |
| Устанавливает лицензию в конвертер. Подробнее... | |
| void | WriteLicense (uint32_t nLicenseN, const void *pData, size_t nSize, ilg_license_info *pInfo=nullptr) |
| Устанавливает лицензию в конвертер. Подробнее... | |
| CAsyncCommand | Begin_WriteLicense (uint32_t nLicenseN, const void *pData, size_t nSize) |
| Запускает асинхронную команду установки лицензии в конвертер. Подробнее... | |
| void | ClearLicenses (bool fDisconnect=false) |
| Удаляет все лицензии. Подробнее... | |
| CAsyncCommand | Begin_ClearLicenses (bool fDisconnect=false) |
| Запускает асинхронную команду удаления всех лицензий. Подробнее... | |
| void | Scan (bool fReset=false, bool fForce=false) |
| Ищет контроллеры. Подробнее... | |
| CAsyncCommand | Begin_Scan (bool fReset=false, bool fForce=false) |
| Запускает асинхронную команду поиска конвертеров. Подробнее... | |
| size_t | GetControllerCount () const |
| Возвращает количество найденных контроллеров. Подробнее... | |
| void | GetControllerInfo (size_t nIdx, ilg_controller_info &rInfo) const |
| Возвращает инфо о найденном контроллере. Подробнее... | |
| void | SetAutoScan (bool fEnable=true, bool fWait=false) |
| Вкл/выкл режим авто поиска контроллеров. Подробнее... | |
| CAsyncCommand | Begin_SetAutoScan (bool fEnable=true) |
| Запускает асинхронную команду вкл/выкл автоматического сканирования контроллеров. Подробнее... | |
| bool | GetAutoScan () const |
| Возвращает True если авто поиск контроллеров включен. Подробнее... | |
| void | SetFirmware (const void *pData, size_t nSize) |
| Устанавливает прошивку в конвертер. Подробнее... | |
| CAsyncCommand | Begin_SetFirmware (const void *pData, size_t nSize) |
| Запускает асинхронную команду установки прошивки конвертера. Подробнее... | |
| CController | GetController (ilg_controller_model nModel, int nSn) |
| Возвращает дескриптор подключения к контроллеру. Подробнее... | |
| CConverter | Clone () const |
| Клонирует дескриптор конвертера. Подробнее... | |
Открытые члены унаследованные от ilg::CILGHandle | |
| CILGHandle () | |
| Конструктор по умолчанию. | |
| CILGHandle (ilg_handle h) | |
| Конструктор из дескриптора SDK. Подробнее... | |
| CILGHandle (const CILGHandle &)=delete | |
| Запрещаем копирование этого класса (т.к. он содержит указатель = дескриптор). | |
| CILGHandle (CILGHandle &&other) | |
| Конструктор перемещения. Подробнее... | |
| virtual | ~CILGHandle () |
| Деструктор | |
| CILGHandle & | operator= (const CILGHandle &)=delete |
| Запрещаем копирование этого класса (т.к. он содержит указатель = дескриптор). | |
| CILGHandle & | operator= (CILGHandle &&other) |
| Оператор перемещения. Подробнее... | |
| operator ilg_handle () const | |
| Оператор приведения типа к ilg_handle. | |
| operator bool () const | |
| Проверяет дескриптор на валидность. | |
| void | Swap (CILGHandle &other) noexcept |
| Обменивается значением с другим дескриптором. Подробнее... | |
| ilg_handle | Get () const |
| Возвращает дескриптор SDK. | |
| void | Close () |
| Закрывает дескриптор SDK. Подробнее... | |
| void | Attach (ilg_handle h) |
| Присоединяет дескриптор к этому объекту. Подробнее... | |
| ilg_handle | Detach () |
| Отсоединяет дескриптор от этого объекту. Подробнее... | |
Открытые статические члены | |
| static void | End_ReadLicenseInfo (ilg_handle hCommand, ilg_license_info &rInfo) |
| Возвращает результат запроса инфо о лицензии конвертера. Подробнее... | |
| static void | End_GetLicenseCount (ilg_handle hCommand, size_t &nCount) |
| Возвращает количество установленных лицензий. Подробнее... | |
| static void | End_WriteLicense (ilg_handle hCommand, ilg_license_info &rInfo) |
| Возвращает результат установки лицензии в конвертер. Подробнее... | |
Дополнительные унаследованные члены | |
Защищенные данные унаследованные от ilg::CILGHandle | |
| ilg_handle | m_h |
| Дескриптор SDK. | |
Класс конвертера.
Класс-обёртка для дескриптора конвертера.
| ilg::CConverter::CConverter | ( | ilg_handle | h | ) |
Конструктор класса из дескриптора конвертера.
| [in] | h | Значение дескриптора SDK. |
| ilg::CConverter::CConverter | ( | CConverter && | other | ) |
Конструктор перемещения.
| [in,out] | other | Другой конвертер. |
|
inline |
Запускает асинхронную команду удаления всех лицензий.
| [in] | fDisconnect | true, после установки лицензии отключается от конвертера , иначе - устанавливает лицензию #5 по умолчанию. |
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду подключения к конвертеру.
| [in] | fReconnect | true, переподключиться. |
| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду отключения от конвертера.
| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду получения количества установленных лицензий.
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду запроса инфо о лицензии конвертера.
| [in] | nLicenseN | Номер лицензии, информацию о которой нужно получить. |
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду поиска конвертеров.
| [in] | fReset | true, очистить список найденных перед поиском. |
| [in] | fForce | true, повторить поиск, даже если уже выполнен авто поиск. |
| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду вкл/выкл автоматического сканирования контроллеров.
| [in] | fEnable | true, включает авто сканирование, иначе - выключает. |
| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду установки прошивки конвертера.
| [in] | pData | Данные прошивки. |
| [in] | nSize | Размер данных прошивки в байтах. |
| CILGException | если произошла ошибка. |
|
inline |
Запускает асинхронную команду установки лицензии в конвертер.
| [in] | nLicenseN | Номер лицензии. |
| [in] | pData | Данные лицензии. |
| [in] | nSize | Количество байт данных лицензии. |
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Удаляет все лицензии.
| [in] | fDisconnect | true, после установки лицензии отключается от конвертера , иначе - устанавливает лицензию #5 по умолчанию. |
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Клонирует дескриптор конвертера.
|
inline |
Подключается к конвертеру.
| [in] | fReconnect | true, Отключается перед подключением. |
| CILGException | если произошла ошибка. |
|
inline |
Отключается от конвертера.
| CILGException | если произошла ошибка. |
|
inline |
Включает/выключает очередь сообщений.
Эта функция устанавливает/снимает флаг в дескрипторе конвертера. Очередь сообщений предназначена для синхронизации обработки сообщений.
| [in] | fEnable | true, включает очередь, иначе - выключает. |
| CILGException(ILG_E_HANDLE) | если дескриптор неправильный. |
|
inlinestatic |
Возвращает количество установленных лицензий.
| [in] | hCommand | Дескриптор команды, которую вернула функция Begin_GetLicenseCount. |
| [out] | nCount | Количество установленных лицензий. |
| CILGException | если произошла ошибка. |
|
inlinestatic |
Возвращает результат запроса инфо о лицензии конвертера.
| [in] | hCommand | Дескриптор команды, которую вернула функция Begin_ReadLicenseInfo. |
| [out] | rInfo | Информация о лицензии конвертера. |
| CILGException | если произошла ошибка. |
|
inlinestatic |
Возвращает результат установки лицензии в конвертер.
| [in] | hCommand | Дескриптор команды, которую вернула функция Begin_WriteLicense. |
| [out] | rInfo | Информация о лицензии. |
| CILGException | если произошла ошибка. |
|
inline |
Возвращает True если авто поиск контроллеров включен.
true, поиск контроллеров включен, иначе - выключен.| CILGException | если произошла ошибка. |
|
inline |
Возвращает состояние подключения к конвертеру.
| CILGException | если произошла ошибка. |
|
inline |
Возвращает дескриптор подключения к контроллеру.
| [in] | nModel | Модель контроллера. |
| [in] | nSn | Серийный номер контроллера. |
| CILGException | если произошла ошибка. |
|
inline |
Возвращает количество найденных контроллеров.
| CILGException | если произошла ошибка. |
|
inline |
Возвращает инфо о найденном контроллере.
| [in] | nIdx | Позиция в списке найденных контроллеров. |
| [out] | rInfo | Информация о найденном контроллере. |
| CILGException | если произошла ошибка. |
|
inline |
Возвращает информацию о конвертере.
| [out] | rInfo | Информация о конвертере. |
rInfo ссылки pszPortName и pszConnect действительны пока жив этот класс дескриптора.| CILGException | если произошла ошибка. |
|
inline |
Возвращает количество установленных лицензий.
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Возвращает инфо о лицензии из списка, полученного методом GetLicenseCount.
| [in] | nIdx | Позиция в списке. |
| [out] | rInfo | Информация о лицензии. |
| CILGException | если произошла ошибка. |
|
inline |
Извлекает следующее сообщение из очереди.
| [out] | nMsg | Тип сообщения. |
| [out] | pMsgData | Указатель на данные пользователя, которые были установлены функцией SetMessageCallback. |
true, если сообщение успешно извлечено, иначе - очередь пуста.| CILGException(ILG_E_HANDLE) | если дескриптор неправильный. |
|
inline |
Возвращает параметры конвертера.
| [in] | rOptions | Параметры конвертера. |
| CILGException | если произошла ошибка. |
|
inline |
Возвращает информацию о текущей лицензии конвертера.
| [out] | rInfo | Информация о лицензии. |
| [in] | fForce | true, прочитать инфо из конвертера, иначе взять из кэша. |
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Читает информацию о лицензии конвертера.
| [in] | nLicenseN | Номер лицензии, информацию о которой нужно получить. |
| [out] | rInfo | Информация о лицензии. |
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Ищет контроллеры.
| [in] | fReset | true, сбросить старые результаты поиска. |
| [in] | fForce | true, повторить поиск, даже если уже выполнен авто поиск. |
| CILGException | если произошла ошибка. |
|
inline |
Вкл/выкл режим авто поиска контроллеров.
| [in] | fEnable | true, включить поиск в реальном времени, иначе - выключить. |
| [in] | fWait | true, ждать завершение операции. |
fWait =true, то функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.| CILGException | если произошла ошибка. |
|
inline |
Устанавливает прошивку в конвертер.
| [in] | pData | Данные прошивки. |
| [in] | nSize | Размер данных прошивки в байтах. |
| CILGException | если произошла ошибка. |
|
inline |
Устанавливает функцию обратного вызова для уведомлений конвертера.
Устанавливает функцию для получения сообщений от дескриптора конвертера.
| [in] | pCallback | Указатель на функцию, которую библиотека будет вызывать при возникновении события конвертера. |
| [in] | pUserData | Указатель на данные пользователя, который будет передаваться в функцию. |
try catch. Нельзя из callback-функции вызывать функции, которые ждут выполнение команды в потоке, из которого вызвана эта callback-функция, иначе вернёт ошибку ILG_E_BLOCKING_CALL_NOT_ALLOWED.
|
inline |
Устанавливает параметры конвертера.
| [in] | rOptions | Параметры конвертера. |
| CILGException | если произошла ошибка. |
|
inline |
Устанавливает лицензию в конвертер.
| [in] | pData | Данные лицензии. |
| [in] | nSize | Количество байт данных лицензии. |
Advanced конвертера.| CILGException | если произошла ошибка. |
|
inline |
Устанавливает лицензию в конвертер.
| [in] | nLicenseN | Номер лицензии. |
| [in] | pData | Данные лицензии. |
| [in] | nSize | Количество байт данных лицензии. |
| [out] | pInfo | Информация о лицензии. Может быть равен nullptr. |
Advanced конвертера.| CILGException | если произошла ошибка. |