SDK Guard 1.0.1
SDK для связи с сетевыми контроллерами Iron logic
Класс ilg::CILGfinal

Класс для инициализации/финализации библиотеки SDK. Подробнее...

#include <ilg_cpp_helpers.h>

Открытые члены

 CILG (bool fInit=true)
 Конструктор по умолчанию Подробнее...
 
 ~CILG ()
 Деструктор Подробнее...
 
void Init ()
 
void SetFilterPortCallback (ilg_filter_port_callback pCallback, void *pUserData=nullptr)
 Устанавливает функцию обратного вызова для фильтрации портов при поиске считывателей. Подробнее...
 
void SetOptions (const ilg_options &rOptions)
 Устанавливает глобальные настройки библиотеки. Подробнее...
 
void GetOptions (ilg_options &rOptions) const
 Возвращает глобальные настройки библиотеки. Подробнее...
 
CConverterSearch GetSearch ()
 Создаёт дескриптор поиска конвертеров. Подробнее...
 
CConverter GetConverter (ilg_port_type nPortType, const char *pszPortName)
 Создаёт дескриптор конвертера. Подробнее...
 

Открытые статические члены

static uint32_t GetVersion ()
 Возвращает номер версии библиотеки.
 
static bool CheckVersion ()
 Проверяет версию SDK. Подробнее...
 
static void SetLogLevel (ilg_log_level nLevel)
 Устанавливает уровень лога отладки. Подробнее...
 
static void SetLogCallback (ilg_logging_callback pCallback, void *pUserData=nullptr)
 Устанавливает функцию обратного вызова для лога отладки. Подробнее...
 

Защищенные данные

bool m_fInit = false
 

Подробное описание

Конструктор(ы)

◆ CILG()

ilg::CILG::CILG ( bool  fInit = true)

Конструктор по умолчанию

Инициализирует библиотеку с помощью функции ilg_init.

◆ ~CILG()

ilg::CILG::~CILG ( )

Деструктор

Завершает работу с библиотекой с помощью ilg_cleanup.

Методы

◆ CheckVersion()

bool ilg::CILG::CheckVersion ( )
inlinestatic

Проверяет версию SDK.

Возвращает
True, если версия библиотеки совместима с заголовочным файлом.

◆ GetConverter()

CConverter ilg::CILG::GetConverter ( ilg_port_type  nPortType,
const char *  pszPortName 
)
inline

Создаёт дескриптор конвертера.

Аргументы
[in]nPortTypeТип порта.
[in]pszPortNameИмя порта.
Прим.
Эта функция создаёт поток конвертера, если ещё не создан (один поток на порт). Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера. Функция позволяет создать более одного дескриптора для одного порта.
Возвращает
Класс конвертеров.
Исключения
CILGExceptionесли произошла ошибка.
Примеры
connect_to_converter/main.cpp, controller_detector/main.cpp, controller_events/main.cpp, controller_keys/main.cpp, controller_lock/main.cpp, controller_schedule/main.cpp и enum_controllers/main.cpp.

◆ GetOptions()

void ilg::CILG::GetOptions ( ilg_options rOptions) const
inline

Возвращает глобальные настройки библиотеки.

Аргументы
[out]rOptionsОпции библиотеки.
Исключения
CILGExceptionесли произошла ошибка `ILG_E_OUTOFMEMORY`, `ILG_E_FAIL`.
Примеры
connect_to_converter/main.cpp.

◆ GetSearch()

CConverterSearch ilg::CILG::GetSearch ( )
inline

Создаёт дескриптор поиска конвертеров.

Прим.
Эта функция создаёт поток поиска конвертеров, если ещё не создан (один поток на библиотеку). Функция не возвращает управление пока ждёт выполнение команды в потоке поиска конвертеров.
Возвращает
Класс поиска конвертеров.
Исключения
CILGExceptionесли произошла ошибка `ILG_E_OUTOFMEMORY`, `ILG_E_FAIL`, ILG_E_BLOCKING_CALL_NOT_ALLOWED, ILG_E_OUT_OF_RESOURCES.
Примеры
connect_to_converter/main.cpp, controller_detector/main.cpp, controller_events/main.cpp, controller_keys/main.cpp, controller_lock/main.cpp, controller_schedule/main.cpp, converter_detector/main.cpp, enum_controllers/main.cpp и enum_converters/main.cpp.

◆ Init()

void ilg::CILG::Init ( )

Инициализирует библиотеку.

◆ SetFilterPortCallback()

void ilg::CILG::SetFilterPortCallback ( ilg_filter_port_callback  pCallback,
void *  pUserData = nullptr 
)
inline

Устанавливает функцию обратного вызова для фильтрации портов при поиске считывателей.

Аргументы
[in]pCallbackУказатель на функцию, которую поток поиска считывателей будет вызывать при нахождении порта.
[in]pUserDataУказатель на данные пользователя, который будет передаваться в функцию.
Предупреждения
Не позволяйте исключениям выйти из callback-функции, оберните код в try catch. Нельзя из callback-функции вызывать функции, которые ждут выполнение команды в потоке, из которого вызвана эта callback-функция, иначе вернёт ошибку ILG_E_BLOCKING_CALL_NOT_ALLOWED.
Исключения
CILGExceptionесли произошла ошибка `ILG_E_OUTOFMEMORY`, `ILG_E_FAIL`.

◆ SetLogCallback()

void ilg::CILG::SetLogCallback ( ilg_logging_callback  pCallback,
void *  pUserData = nullptr 
)
inlinestatic

Устанавливает функцию обратного вызова для лога отладки.

Аргументы
[in]pCallbackУказатель на функцию, которую библиотека будет вызывать для передачи сообщений лога отладки.
[in]pUserDataУказатель на данные пользователя, который будет передаваться в функцию.
Предупреждения
Не позволяйте исключениям выйти из callback-функции, оберните код в try catch. Нельзя из callback-функции вызывать функции, которые ждут выполнение команды в потоке, из которого вызвана эта callback-функция, иначе вернёт ошибку ILG_E_BLOCKING_CALL_NOT_ALLOWED.

◆ SetLogLevel()

void ilg::CILG::SetLogLevel ( ilg_log_level  nLevel)
inlinestatic

Устанавливает уровень лога отладки.

Аргументы
[in]nLevelУровень лога отладки.

◆ SetOptions()

void ilg::CILG::SetOptions ( const ilg_options rOptions)
inline

Устанавливает глобальные настройки библиотеки.

Аргументы
[in]rOptionsОпции библиотеки.
Исключения
CILGExceptionесли произошла ошибка `ILG_E_OUTOFMEMORY`, `ILG_E_FAIL`.
Примеры
connect_to_converter/main.cpp.

Данные класса

◆ m_fInit

bool ilg::CILG::m_fInit = false
protected

true, библиотека инициализирована.


Объявления и описания членов классов находятся в файлах: