Класс ilr::CAsyncCommand

Класс команды SDK. Подробнее...

#include <ilr_cpp_helpers.h>

Граф наследования:ilr::CAsyncCommand:

Граф связей класса ilr::CAsyncCommand:

Открытые члены
	CAsyncCommand ()
	Конструктор по умолчанию.
	CAsyncCommand (ilr_handle h)
	Конструктор класса из дескриптора команды. Подробнее...
	CAsyncCommand (CAsyncCommand &&other)
	Конструктор перемещения. Подробнее...
virtual	~CAsyncCommand ()
	Деструктор
CAsyncCommand &	operator= (CAsyncCommand &&other)
	Оператор перемещения
void	Cancel ()
	Отменяет команду. Устанавливает статус ILR_E_ABORT. Подробнее...
ilr_status	GetStatus () const
	Возвращает состояние команды. Подробнее...
void	GetProgress (size_t &nCurrent, size_t &nTotal) const
	Возвращает состояние прогресса выполнения команды. Подробнее...
Открытые члены унаследованные от ilr::CILRHandle
	CILRHandle ()
	Конструктор по умолчанию.
	CILRHandle (ilr_handle h)
	Конструктор из дескриптора SDK. Подробнее...
	CILRHandle (const CILRHandle &)=delete
	Запрещаем копирование этого класса (т.к. он содержит указатель = дескриптор).
	CILRHandle (CILRHandle &&other)
	Конструктор перемещения. Подробнее...
virtual	~CILRHandle ()
	Деструктор
CILRHandle &	operator= (const CILRHandle &)=delete
	Запрещаем копирование этого класса (т.к. он содержит указатель = дескриптор).
CILRHandle &	operator= (CILRHandle &&other)
	Оператор перемещения. Подробнее...
	operator ilr_handle () const
	Оператор приведения типа к ilr_handle.
	operator bool () const
	Проверяет дескриптор на валидность.
void	Swap (CILRHandle &other) noexcept
	Обменивается значением с другим дескриптором. Подробнее...
ilr_handle	Get () const
	Возвращает дескриптор SDK.
void	Close ()
	Закрывает дескриптор SDK. Подробнее...
void	Attach (ilr_handle h)
	Присоединяет дескриптор к этому объекту. Подробнее...
ilr_handle	Detach ()
	Отсоединяет дескриптор от этого объекту. Подробнее...

Дополнительные унаследованные члены
Защищенные данные унаследованные от ilr::CILRHandle
ilr_handle	m_h
	Дескриптор SDK.

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

Класс команды SDK.

Класс для управления асинхронными запросом.

Примеры

auto_read_card/main.cpp.

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

CAsyncCommand() [1/2]

ilr::CAsyncCommand::CAsyncCommand

(

ilr_handle

h

)

Конструктор класса из дескриптора команды.

Аргументы

[in]

h

Значение дескриптора SDK.

CAsyncCommand() [2/2]

ilr::CAsyncCommand::CAsyncCommand

(

CAsyncCommand &&

other

)

Конструктор перемещения.

Аргументы

[in,out]

other

Другой дескриптор команды.

Методы

Cancel()

void ilr::CAsyncCommand::Cancel ( )

inline

Отменяет команду. Устанавливает статус ILR_E_ABORT.

Исключения

CILRException(ILR_E_HANDLE)

если дескриптор неправильный.

Примеры

auto_read_card/main.cpp.

GetProgress()

void ilr::CAsyncCommand::GetProgress ( size_t &  nCurrent, size_t &  nTotal  ) const

inline

Возвращает состояние прогресса выполнения команды.

Аргументы

[out]	nCurrent	Текущий шаг.
[out]	nTotal	Всего шагов.

Исключения

CILRException(ILR_E_HANDLE)

если дескриптор неправильный.

GetStatus()

ilr_status ilr::CAsyncCommand::GetStatus ( ) const

inline

Возвращает состояние команды.

Возвращает

Состояние команды: =ILR_E_PENDING команда ещё выполняется, иначе - завершена.

Исключения

CILRException(ILR_E_HANDLE)

если дескриптор неправильный.

Примеры

auto_read_card/main.cpp.

---

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

• ilr_cpp_helpers.h
• ilr_cpp_helpers.cpp