SDK Readers 1.0.1
SDK для связи со считывателями Iron logic
Класс ilr::CILRfinal

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

#include <ilr_cpp_helpers.h>

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

 CILR (bool fInit=true)
 Конструктор по умолчанию Подробнее...
 
 ~CILR ()
 Деструктор Подробнее...
 
void Init ()
 
void Finalize ()
 
void SetFilterPortCallback (ilr_filter_port_callback pCallback, void *pUserData=nullptr)
 Устанавливает функцию обратного вызова для фильтрации портов при поиске считывателей. Подробнее...
 
void SetOptions (const ilr_options &rOptions)
 Устанавливает глобальные настройки библиотеки. Подробнее...
 
void GetOptions (ilr_options &rOptions) const
 Возвращает глобальные настройки библиотеки. Подробнее...
 
CReaderSearch GetSearch ()
 Создаёт дескриптор поиска считывателей. Подробнее...
 
CReader GetReader (ilr_port_type nPortType, const char *pszPortName)
 Создаёт дескриптор считывателя. Подробнее...
 

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

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

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

bool m_fInit = false
 

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

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

Примеры
auto_read_card/main.cpp, card_detector/main.cpp, connect_to_reader/main.cpp, enum_readers/main.cpp, mf_classic/main.cpp, mf_plus/main.cpp, mf_ultralight/main.cpp, reader_detector/main.cpp и temic/main.cpp.

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

◆ CILR()

ilr::CILR::CILR ( bool  fInit = true)

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

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

◆ ~CILR()

ilr::CILR::~CILR ( )

Деструктор

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

Методы

◆ CheckVersion()

bool ilr::CILR::CheckVersion ( )
inlinestatic

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

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

◆ Finalize()

void ilr::CILR::Finalize ( )

Завершает работу библиотеки.

◆ GetOptions()

void ilr::CILR::GetOptions ( ilr_options rOptions) const
inline

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

Аргументы
[out]rOptionsОпции библиотеки.
Исключения
CILRExceptionесли произошла ошибка `ILR_E_OUTOFMEMORY`, `ILR_E_FAIL`.

◆ GetReader()

CReader ilr::CILR::GetReader ( ilr_port_type  nPortType,
const char *  pszPortName 
)
inline

Создаёт дескриптор считывателя.

Аргументы
[in]nPortTypeТип порта.
[in]pszPortNameИмя порта.
Прим.
Эта функция создаёт поток считывателя, если ещё не создан (один поток на порт). Функция не возвращает управление пока ждёт выполнение команды в потоке считывателя. Функция позволяет создать более одного дескриптора для одного порта.
Возвращает
Класс считывателя.
Исключения
CILRExceptionесли произошла ошибка `ILR_E_OUTOFMEMORY`, `ILR_E_FAIL`, ILR_E_INVALIDARG, ILR_E_BLOCKING_CALL_NOT_ALLOWED, ILR_E_OUT_OF_RESOURCES.
Примеры
auto_read_card/main.cpp, card_detector/main.cpp, connect_to_reader/main.cpp, mf_classic/main.cpp, mf_plus/main.cpp, mf_ultralight/main.cpp и temic/main.cpp.

◆ GetSearch()

CReaderSearch ilr::CILR::GetSearch ( )
inline

Создаёт дескриптор поиска считывателей.

Прим.
Эта функция создаёт поток поиска считывателей, если ещё не создан (один поток на библиотеку). Функция не возвращает управление пока ждёт выполнение команды в потоке поиска считывателей.
Возвращает
Класс поиска считывателей.
Исключения
CILRExceptionесли произошла ошибка `ILR_E_OUTOFMEMORY`, `ILR_E_FAIL`, ILR_E_BLOCKING_CALL_NOT_ALLOWED, ILR_E_OUT_OF_RESOURCES.
Примеры
auto_read_card/main.cpp, card_detector/main.cpp, connect_to_reader/main.cpp, enum_readers/main.cpp, mf_classic/main.cpp, mf_plus/main.cpp, mf_ultralight/main.cpp, reader_detector/main.cpp и temic/main.cpp.

◆ Init()

void ilr::CILR::Init ( )

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

◆ SetFilterPortCallback()

void ilr::CILR::SetFilterPortCallback ( ilr_filter_port_callback  pCallback,
void *  pUserData = nullptr 
)
inline

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

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

◆ SetLogCallback()

void ilr::CILR::SetLogCallback ( ilr_logging_callback  pCallback,
void *  pUserData = nullptr 
)
inlinestatic

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

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

◆ SetLogLevel()

void ilr::CILR::SetLogLevel ( ilr_log_level  nLevel)
inlinestatic

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

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

◆ SetOptions()

void ilr::CILR::SetOptions ( const ilr_options rOptions)
inline

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

Аргументы
[in]rOptionsОпции библиотеки.
Исключения
CILRExceptionесли произошла ошибка `ILR_E_OUTOFMEMORY`, `ILR_E_FAIL`.

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

◆ m_fInit

bool ilr::CILR::m_fInit = false
protected

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


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