Класс контроллера. Подробнее...

#include <ilg_cpp_helpers.h>

Граф наследования:ilg::CController:

Граф связей класса ilg::CController:

Открытые члены
	CController ()
	Конструктор по умолчанию.

	CController (ilg_handle h)
	Конструктор класса из дескриптора контроллера. Подробнее...

	CController (CController &&other)
	Конструктор перемещения. Подробнее...

virtual	~CController ()
	Деструктор

CController &	operator= (CController &&other)
	Оператор перемещения

void	SetMessageCallback (ilg_controller_message_callback pCallback, void *pUserData=nullptr)
	Устанавливает функцию обратного вызова для уведомлений контроллера. Подробнее...

void	EnableMessageQueue (bool fEnable=true)
	Включает/выключает очередь сообщений. Подробнее...

bool	GetMessage (ilg_controller_msg &nMsg, const void *&pMsgData) const
	Извлекает следующее сообщение из очереди. Подробнее...

void	SetOptions (const ilg_controller_options &rOptions)
	Устанавливает параметры контроллера. Подробнее...

void	GetOptions (ilg_controller_options &rOptions)
	Возвращает параметры контроллера. Подробнее...

void	Connect (bool fReconnect=false)
	Подключается к контроллеру. Подробнее...

CAsyncCommand	Begin_Connect (bool fReconnect=false)
	Запускает асинхронную команду подключения к контроллеру. Подробнее...

void	Disconnect ()
	Отключается от контроллера. Подробнее...

CAsyncCommand	Begin_Disconnect ()
	Запускает асинхронную команду отключения от контроллера. Подробнее...

ilg_connection_status	GetConnectionStatus () const
	Возвращает состояние подключения к контроллеру. Подробнее...

void	GetControllerInfo (ilg_controller_info &rInfo) const
	Возвращает информацию о контроллере. Подробнее...

void	GetConverterInfo (ilg_converter_info &rInfo) const
	Возвращает информацию о конвертере. Подробнее...

CConverter	GetConverter () const
	Создаёт дескриптор конвертера. Подробнее...

std::string	ReadLines ()
	Читает информационные строки контроллера. Подробнее...

CAsyncCommand	Begin_ReadLines ()
	Запускает асинхронную команду чтения инфо строк контроллера. Подробнее...

void	ReadLockTimes (uint8_t nBankN, uint16_t &nOpen, uint16_t &nLet, uint16_t &nMax, bool &fBigTime)
	Читает времена замка из памяти контроллера. Подробнее...

CAsyncCommand	Begin_ReadLockTimes (uint8_t nBankN)
	Запускает асинхронную команду чтения времён замка. Подробнее...

void	WriteLockTimes (uint8_t nBankN, uint16_t nOpen, uint16_t nLet, uint16_t nMax, bool fBigTime)
	Пишет времена замка в память контроллера. Подробнее...

CAsyncCommand	Begin_WriteLockTimes (uint8_t nBankN, uint16_t nOpen, uint16_t nLet, uint16_t nMax, bool fBigTime)
	Запускает асинхронную команду записи времён замка. Подробнее...

void	ReadApbTime (bool &fEnabled, uint16_t &nMinutes)
	Читает время антипассбэк из контроллера. Подробнее...

CAsyncCommand	Begin_ReadApbTime ()
	Запускает асинхронную команду чтения времени антипассбэк. Подробнее...

void	WriteApbTime (bool fEnabled, uint16_t nMinutes)
	Пишет время антипассбэк в контроллер. Подробнее...

CAsyncCommand	Begin_WriteApbTime (bool fEnabled, uint16_t nMinutes)
	Запускает асинхронную команду записи времён замка. Подробнее...

void	ReadTimeZones (uint8_t nBankN, size_t nIdx, ilg_time_zone pBuf, size_t nCount, size_t pRead=nullptr)
	Читает временные зоны из контроллера. Подробнее...

CAsyncCommand	Begin_ReadTimeZones (uint8_t nBankN, size_t nIdx, size_t nCount)
	Запускает асинхронную команду чтения временных зон. Подробнее...

void	WriteTimeZones (uint8_t nBankN, size_t nIdx, const ilg_time_zone pTZs, size_t nCount, size_t pWritten=nullptr)
	Пишет временные зоны в контроллер. Подробнее...

CAsyncCommand	Begin_WriteTimeZones (uint8_t nBankN, size_t nIdx, const ilg_time_zone *pTZs, size_t nCount)
	Запускает асинхронную команду записи временных зон. Подробнее...

void	ReadModeTimeZones (size_t nIdx, ilg_mode_time_zone *pBuf, size_t nCount)
	Читает временные зоны для переключения режима контроллера. Подробнее...

CAsyncCommand	Begin_ReadModeTimZones (size_t nIdx, size_t nCount)
	Запускает асинхронную команду чтения временных зон для переключения режима контроллера. Подробнее...

void	WriteModeTimeZones (size_t nIdx, const ilg_mode_time_zone *pTZs, size_t nCount)
	Пишет временные зоны для переключения режима контроллера. Подробнее...

CAsyncCommand	Begin_WriteModeTimeZones (size_t nIdx, const ilg_mode_time_zone *pTZs, size_t nCount)
	Запускает асинхронную команду записи временных зон для переключения режима контроллера. Подробнее...

void	ReadKeys (uint8_t nBankN, size_t nIdx, ilg_key pBuf, size_t nCount, size_t pRead=nullptr)
	Читает ключи из памяти контроллера. Подробнее...

CAsyncCommand	Begin_ReadKeys (uint8_t nBankN, size_t nIdx, size_t nCount)
	Запускает асинхронную команду чтения ключей. Подробнее...

void	WriteKeys (uint8_t nBankN, size_t nIdx, const ilg_key pKeys, size_t nCount, size_t pWritten=nullptr, bool fSelected=false)
	Пишет ключи в память контроллера. Подробнее...

CAsyncCommand	Begin_WriteKeys (uint8_t nBankN, size_t nIdx, const ilg_key *pKeys, size_t nCount, bool fSelected=false)
	Запускает асинхронную команду записи ключей. Подробнее...

void	EraseKeys (uint8_t nBankN, size_t nIdx, size_t nCount, size_t *pErased=nullptr)
	Стирает ключи в памяти контроллера. Подробнее...

CAsyncCommand	Begin_EraseKeys (uint8_t nBankN, size_t nIdx, size_t nCount)
	Запускает асинхронную команду стирания ключей. Подробнее...

void	EraseKeys2 (uint8_t nBankN, const size_t pIdxs, size_t nCount, size_t pErased=nullptr)
	Стирает ключи в указанных ячейках. Подробнее...

CAsyncCommand	Begin_EraseKeys2 (uint8_t nBankN, const size_t *pIdxs, size_t nCount)
	Запускает асинхронную команду стирания ключей в указанных ячейках. Подробнее...

ssize_t	ReadKeyTopIdx (uint8_t nBankN)
	Читает верхнюю границу ключей. Подробнее...

CAsyncCommand	Begin_ReadKeyTopIdx (uint8_t nBankN)
	Запускает асинхронную команду чтения верхней границы ключей. Подробнее...

void	ReadEvents (size_t nIdx, uint64_t pBuf, size_t nCount, size_t pRead=nullptr)
	Читает события из памяти контроллера. Подробнее...

CAsyncCommand	Begin_ReadEvents (size_t nIdx, size_t nCount)
	Запускает асинхронную команду чтения событий. Подробнее...

void	WriteEventReadIdx (size_t nIdx)
	Пишет позицию указателя чтения событий. Подробнее...

CAsyncCommand	Begin_WriteEventReadIdx (size_t nIdx)
	Запускает асинхронную команду записи указателя чтения событий. Подробнее...

void	ReadRtcParams (ilg_rtc_params &rParams)
	Читает параметры RTC из контроллера. Подробнее...

CAsyncCommand	Begin_ReadRtcParams ()
	Запускает асинхронную команду чтения параметров RTC. Подробнее...

void	GetRtcParams (ilg_rtc_params &rParams)
	Возвращает результат авто опроса параметров RTC. Подробнее...

void	ReadExtAskParams (ilg_extask_params &rParams)
	Читает параметры ExtAsk из контроллера. Подробнее...

CAsyncCommand	Begin_ReadExtAskParams ()
	Запускает асинхронную команду чтения параметров ExtAsk. Подробнее...

void	GetExtAskParams (ilg_extask_params &rParams)
	Возвращает результат авто опроса ExtAsk. Подробнее...

void	SyncClock ()
	Синхронизирует часы контроллера с часами ПК. Подробнее...

CAsyncCommand	Begin_SyncClock ()
	Запускает асинхронную команду синхронизации часов контроллера с часами ПК. Подробнее...

void	SetEmergencyMode (bool fEnable)
	Вкл/выкл старый режим аварийного открывания дверей. Подробнее...

CAsyncCommand	Begin_SetEmergencyMode (bool fEnable)
	Запускает асинхронную команду вкл/выкл старого режима аварийного открывания дверей. Подробнее...

void	ReadAntiCovid (uint16_t pMax8, uint16_t pCount8)
	Читает параметры AntiCovid. Подробнее...

CAsyncCommand	Begin_ReadAntiCovid ()
	Запускает асинхронную команду чтения параметров AntiCovid. Подробнее...

void	WriteAntiCovid (const uint16_t *pMax8)
	Пишет максимумы AntiCovid. Подробнее...

CAsyncCommand	Begin_WriteAntiCovid (const uint16_t *pMax8)
	Запускает асинхронную команду записи максимумов AntiCovid. Подробнее...

void	OpenDoor (bool fOut)
	Открывает дверь. Подробнее...

CAsyncCommand	Begin_OpenDoor (bool fOut)
	Запускает асинхронную команду открытия двери. Подробнее...

void	SetFireMode (bool fOn)
	Вкл/выкл противопожарный режим. Подробнее...

CAsyncCommand	Begin_SetFireMode (bool fOn)
	Запускает асинхронную команду вкл/выкл противопожарного режима. Подробнее...

void	SetSecurityMode (bool fOn)
	Вкл/выкл режим охраны. Подробнее...

CAsyncCommand	Begin_SetSecurityMode (bool fOn)
	Запускает асинхронную команду вкл/выкл режима охраны. Подробнее...

void	SetAlarmMode (bool fOn)
	Вкл/выкл режим тревоги. Подробнее...

CAsyncCommand	Begin_SetAlarmMode (bool fOn)
	Запускает асинхронную команду вкл/выкл режима тревоги. Подробнее...

void	SetEcPower (bool fOn)
	Вкл/выкл питание в режиме Электроконтроль. Подробнее...

CAsyncCommand	Begin_SetEcPower (bool fOn)
	Запускает асинхронную команду вкл/выкл питания в режиме Электроконтроль. Подробнее...

void	ReadFireParams (uint8_t &nSrcMask, uint8_t &nLimitT, uint8_t &nState, uint8_t &nT)
	Читает параметры противопожарного режима. Подробнее...

CAsyncCommand	Begin_ReadFireParams ()
	Запускает асинхронную команду чтения параметров противопожарного режима. Подробнее...

void	WriteFireParams (uint8_t nSrcMask, uint8_t nLimitT, uint8_t pState=nullptr, uint8_t pT=nullptr)
	Пишет параметры противопожарного режима. Подробнее...

CAsyncCommand	Begin_WriteFireParams (uint8_t nSrcMask, uint8_t nLimitT)
	Запускает асинхронную команду записи параметров противопожарного режима. Подробнее...

void	ReadSecurityParams (uint8_t &nSrcMask, uint8_t &nTime, uint8_t &nState)
	Читает параметры режима охраны. Подробнее...

CAsyncCommand	Begin_ReadSecurityParams ()
	Запускает асинхронную команду чтения параметров режима охраны. Подробнее...

void	WriteSecurityParams (uint8_t nSrcMask, uint8_t nTime, uint8_t *pState=nullptr)
	Пишет параметры режима охраны. Подробнее...

CAsyncCommand	Begin_WriteSecurityParams (uint8_t nSrcMask, uint8_t nTime)
	Запускает асинхронную команду записи параметров режима охраны. Подробнее...

void	ReadEcParams (uint8_t &nPowerConfig, uint8_t &nDelay, uint8_t *pState=nullptr)
	Читает параметры режима ЭлектроКонтроль. Подробнее...

CAsyncCommand	Begin_ReadEcParams ()
	Запускает асинхронную команду чтения параметров режима ЭлектроКонтроль. Подробнее...

void	WriteMode (ilg_controller_mode nMode)
	Пишет режим контроллера. Подробнее...

CAsyncCommand	Begin_WriteMode (ilg_controller_mode nMode)
	Запускает асинхронную команду записи режима контроллера. Подробнее...

ilg_controller_mode	ReadMode (uint8_t *pFlags=nullptr)
	Читает режим контроллера. Подробнее...

CAsyncCommand	Begin_ReadMode ()
	Запускает асинхронную команду чтения режима контроллера. Подробнее...

void	WriteConfiguration (const void *pData, size_t nSize)
	Пишет конфигурацию контроллера. Подробнее...

CAsyncCommand	Begin_WriteConfiguration (const void *pData, size_t nSize)
	Запускает асинхронную команду записи конфигурации контроллера. Подробнее...

void	ReadConfiguration (std::vector< uint8_t > &oData)
	Читает конфигурацию контроллера. Подробнее...

CAsyncCommand	Begin_ReadConfiguration ()
	Запускает асинхронную команду чтения конфигурации контроллера. Подробнее...

void	SetNetworkAddress (uint8_t nAddress)
	Устанавливает сетевой адрес контроллеру. Подробнее...

CAsyncCommand	Begin_SetNetworkAddress (uint8_t nAddress)
	Запускает асинхронную команду установки сетевого адреса. Подробнее...

void	SetFirmware (const void *pData, size_t nSize)
	Устанавливает прошивку контроллера. Подробнее...

CAsyncCommand	Begin_SetFirmware (const void *pData, size_t nSize)
	Запускает асинхронную команду установки прошивки контроллера. Подробнее...

ilg_event_type	DecodeEventType (const uint64_t &nEvent, ilg_event_format *pFormat=nullptr)
	Определяет тип события контроллера и формат записи события. Подробнее...

void	DecodePassageEvent (const uint64_t &nEvent, ilg_controller_time &rTime, ilg_direction &nDirection, uint8_t &nKeyBankN, ssize_t &nKeyIdx)
	Декодирует событие прохода. Подробнее...

void	DecodeTimeEvent (const uint64_t &nEvent, ilg_controller_time &rTime)
	Декодирует событие с датой и временем. Подробнее...

void	DecodeControllerModeEvent (const uint64_t &nEvent, ilg_controller_time &rTime, ilg_controller_mode &nMode, uint8_t &nFlags, uint8_t &nTrigger)
	Декодирует событие переключения режима контроллера. Подробнее...

void	DecodeStateEvent (const uint64_t &nEvent, ilg_controller_time &rTime, uint8_t &nFlags, uint8_t &nTrigger)
	Декодирует событие изменения состояния. Подробнее...

void	DecodeKeyNumber (const uint64_t &nEvent, ilg_key_number &rKeyNumber)
	Декодирует событие с номером ключа. Подробнее...

CController	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_ReadLines (ilg_handle hCommand, std::string &sLines)
	Возвращает результат чтения инфо строк контроллера. Подробнее...

static void	End_ReadLockTimes (ilg_handle hCommand, uint16_t &nOpen, uint16_t &nLet, uint16_t &nMax, bool &fBigTime)
	Возвращает результат чтения времён замка. Подробнее...

static void	End_ReadApbTime (ilg_handle hCommand, bool &fEnabled, uint16_t &nMinutes)
	Возвращает результат чтения времени антипассбэк. Подробнее...

static void	End_ReadTimeZones (ilg_handle hCommand, const ilg_time_zone *&pList, size_t &nRead)
	Возвращает результат чтения временных зон. Подробнее...

static void	End_WriteTimeZones (ilg_handle hCommand, size_t &nWritten)
	Возвращает результат записи временных зон. Подробнее...

static void	End_ReadModeTimZones (ilg_handle hCommand, const ilg_mode_time_zone *&pList, size_t &nRead)
	Возвращает результат чтения временных зон для переключения режима контроллера. Подробнее...

static void	End_ReadKeys (ilg_handle hCommand, const ilg_key *&pList, size_t &nRead)
	Возвращает результат чтения ключей. Подробнее...

static void	End_WriteKeys (ilg_handle hCommand, size_t &nWritten)
	Возвращает результат записи ключей. Подробнее...

static void	End_EraseKeys (ilg_handle hCommand, size_t &nErased)
	Возвращает результат стирания ключей. Подробнее...

static void	End_EraseKeys2 (ilg_handle hCommand, size_t &nErased)
	Возвращает результат стирания ключей в указанных ячейках. Подробнее...

static void	End_ReadKeyTopIdx (ilg_handle hCommand, ssize_t &nIdx)
	Возвращает результат чтения верхней границы ключей. Подробнее...

static void	End_ReadEvents (ilg_handle hCommand, const uint64_t *&pList, size_t &nRead)
	Возвращает результат чтения событий. Подробнее...

static void	End_ReadRtcParams (ilg_handle hCommand, ilg_rtc_params &rParams)
	Возвращает результат чтения параметров RTC. Подробнее...

static void	End_ReadExtAskParams (ilg_handle hCommand, ilg_extask_params &rParams)
	Возвращает результат чтения параметров ExtAsk. Подробнее...

static void	End_ReadAntiCovid (ilg_handle hCommand, uint16_t pMax8, uint16_t pCount8)
	Возвращает результат чтения параметров AntiCovid. Подробнее...

static void	End_ReadFireParams (ilg_handle hCommand, uint8_t &nSrcMask, uint8_t &nLimitT, uint8_t &nState, uint8_t &nT)
	Возвращает результат чтения параметров противопожарного режима. Подробнее...

static void	End_WriteFireParams (ilg_handle hCommand, uint8_t &nState, uint8_t &nT)
	Возвращает результат записи параметров противопожарного режима. Подробнее...

static void	End_ReadSecurityParams (ilg_handle hCommand, uint8_t &nSrcMask, uint8_t &nTime, uint8_t &nState)
	Возвращает результат чтения параметров режима охраны. Подробнее...

static void	End_WriteSecurityParams (ilg_handle hCommand, uint8_t &nState)
	Возвращает результат записи параметров режима охраны. Подробнее...

static void	End_ReadEcParams (ilg_handle hCommand, uint8_t &nPowerConfig, uint8_t &nDelay, uint8_t *pState=nullptr)
	Возвращает результат чтения параметров режима ЭлектроКонтроль. Подробнее...

static void	End_ReadMode (ilg_handle hCommand, ilg_controller_mode &nMode, uint8_t *pFlags=nullptr)
	Возвращает результат чтения режима контроллера. Подробнее...

static void	End_ReadConfiguration (ilg_handle hCommand, std::vector< uint8_t > &oData)
	Возвращает результат чтения конфигурации контроллера. Подробнее...

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

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

Класс контроллера.

Класс-обёртка для дескриптора контроллера.

Примеры: controller_events/main.cpp, controller_keys/main.cpp, controller_lock/main.cpp и controller_schedule/main.cpp.

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

◆ CController() [1/2]

ilg::CController::CController ( ilg_handle h )

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

Аргументы

[in] h Значение дескриптора SDK.

◆ CController() [2/2]

ilg::CController::CController ( CController && other )

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

Аргументы

[in,out] other Другой контроллер.

Методы

◆ Begin_Connect()

CAsyncCommand ilg::CController::Begin_Connect ( bool fReconnect = false )

inline

Запускает асинхронную команду подключения к контроллеру.

Аргументы

[in] fReconnect true, переподключиться.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_Disconnect()

CAsyncCommand ilg::CController::Begin_Disconnect ( )

inline

Запускает асинхронную команду отключения от контроллера.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_EraseKeys()

CAsyncCommand ilg::CController::Begin_EraseKeys	(	uint8_t	nBankN,
		size_t	nIdx,
		size_t	nCount
	)

inline

Запускает асинхронную команду стирания ключей.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция ключа в банке ключей.
[in]	nCount	Количество ключей, которые нужно стереть.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_EraseKeys2()

CAsyncCommand ilg::CController::Begin_EraseKeys2	(	uint8_t	nBankN,
		const size_t *	pIdxs,
		size_t	nCount
	)

inline

Запускает асинхронную команду стирания ключей в указанных ячейках.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	pIdxs	Список позиций ключей, сортированный по возрастанию.
[in]	nCount	Количество ключей, которые нужно стереть.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_OpenDoor()

CAsyncCommand ilg::CController::Begin_OpenDoor ( bool fOut )

inline

Запускает асинхронную команду открытия двери.

Аргументы

[in] fOut true, открывает для выхода, иначе - для входа.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadAntiCovid()

CAsyncCommand ilg::CController::Begin_ReadAntiCovid ( )

inline

Запускает асинхронную команду чтения параметров AntiCovid.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadApbTime()

CAsyncCommand ilg::CController::Begin_ReadApbTime ( )

inline

Запускает асинхронную команду чтения времени антипассбэк.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadConfiguration()

CAsyncCommand ilg::CController::Begin_ReadConfiguration ( )

inline

Запускает асинхронную команду чтения конфигурации контроллера.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadEcParams()

CAsyncCommand ilg::CController::Begin_ReadEcParams ( )

inline

Запускает асинхронную команду чтения параметров режима ЭлектроКонтроль.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadEvents()

CAsyncCommand ilg::CController::Begin_ReadEvents	(	size_t	nIdx,
		size_t	nCount
	)

inline

Запускает асинхронную команду чтения событий.

Аргументы

[in]	nIdx	Позиция события в банке событий.
[in]	nCount	Количество событий, которые нужно прочитать.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadExtAskParams()

CAsyncCommand ilg::CController::Begin_ReadExtAskParams ( )

inline

Запускает асинхронную команду чтения параметров ExtAsk.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadFireParams()

CAsyncCommand ilg::CController::Begin_ReadFireParams ( )

inline

Запускает асинхронную команду чтения параметров противопожарного режима.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadKeys()

CAsyncCommand ilg::CController::Begin_ReadKeys	(	uint8_t	nBankN,
		size_t	nIdx,
		size_t	nCount
	)

inline

Запускает асинхронную команду чтения ключей.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция ключа в банке ключей.
[in]	nCount	Количество ключей, которые нужно прочитать.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadKeyTopIdx()

CAsyncCommand ilg::CController::Begin_ReadKeyTopIdx ( uint8_t nBankN )

inline

Запускает асинхронную команду чтения верхней границы ключей.

Аргументы

[in] nBankN Номер банка: =0 вход, =1 выход.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadLines()

CAsyncCommand ilg::CController::Begin_ReadLines ( )

inline

Запускает асинхронную команду чтения инфо строк контроллера.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadLockTimes()

CAsyncCommand ilg::CController::Begin_ReadLockTimes ( uint8_t nBankN )

inline

Запускает асинхронную команду чтения времён замка.

Аргументы

[in] nBankN Номер банка: =0 вход, =1 выход.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadMode()

CAsyncCommand ilg::CController::Begin_ReadMode ( )

inline

Запускает асинхронную команду чтения режима контроллера.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadModeTimZones()

CAsyncCommand ilg::CController::Begin_ReadModeTimZones	(	size_t	nIdx,
		size_t	nCount
	)

inline

Запускает асинхронную команду чтения временных зон для переключения режима контроллера.

Аргументы

[in]	nIdx	Позиция временной зоны 0..1.
[in]	nCount	Количество считываемых временных зон 1..2.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadRtcParams()

CAsyncCommand ilg::CController::Begin_ReadRtcParams ( )

inline

Запускает асинхронную команду чтения параметров RTC.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadSecurityParams()

CAsyncCommand ilg::CController::Begin_ReadSecurityParams ( )

inline

Запускает асинхронную команду чтения параметров режима охраны.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_ReadTimeZones()

CAsyncCommand ilg::CController::Begin_ReadTimeZones	(	uint8_t	nBankN,
		size_t	nIdx,
		size_t	nCount
	)

inline

Запускает асинхронную команду чтения временных зон.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция временной зоны в банке.
[in]	nCount	Количество зон, которые нужно прочитать.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_SetAlarmMode()

CAsyncCommand ilg::CController::Begin_SetAlarmMode ( bool fOn )

inline

Запускает асинхронную команду вкл/выкл режима тревоги.

Аргументы

[in] fOn true, включить режим.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_SetEcPower()

CAsyncCommand ilg::CController::Begin_SetEcPower ( bool fOn )

inline

Запускает асинхронную команду вкл/выкл питания в режиме Электроконтроль.

Аргументы

[in] fOn true, включить питание.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_SetEmergencyMode()

CAsyncCommand ilg::CController::Begin_SetEmergencyMode ( bool fEnable )

inline

Запускает асинхронную команду вкл/выкл старого режима аварийного открывания дверей.

Аргументы

[in] fEnable true, включить аварийный режим.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_SetFireMode()

CAsyncCommand ilg::CController::Begin_SetFireMode ( bool fOn )

inline

Запускает асинхронную команду вкл/выкл противопожарного режима.

Аргументы

[in] fOn true, включить режим.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_SetFirmware()

CAsyncCommand ilg::CController::Begin_SetFirmware	(	const void *	pData,
		size_t	nSize
	)

inline

Запускает асинхронную команду установки прошивки контроллера.

Аргументы

[in]	pData	Данные прошивки.
[in]	nSize	Размер данных прошивки в байтах.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_SetNetworkAddress()

CAsyncCommand ilg::CController::Begin_SetNetworkAddress ( uint8_t nAddress )

inline

Запускает асинхронную команду установки сетевого адреса.

Аргументы

[in] nAddress Адрес контроллера 0..254.

Исключения

CILGException если произошла ошибка.

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

◆ Begin_SetSecurityMode()

CAsyncCommand ilg::CController::Begin_SetSecurityMode ( bool fOn )

inline

Запускает асинхронную команду вкл/выкл режима охраны.

Аргументы

[in] fOn true, включить режим.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_SyncClock()

CAsyncCommand ilg::CController::Begin_SyncClock ( )

inline

Запускает асинхронную команду синхронизации часов контроллера с часами ПК.

Прим.: Получить текущее время контроллера можно с помощью функции ReadRtcParams.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteAntiCovid()

CAsyncCommand ilg::CController::Begin_WriteAntiCovid ( const uint16_t * pMax8 )

inline

Запускает асинхронную команду записи максимумов AntiCovid.

Аргументы

[in] pMax8 Максимумы, массив из 8 элементов.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteApbTime()

CAsyncCommand ilg::CController::Begin_WriteApbTime	(	bool	fEnabled,
		uint16_t	nMinutes
	)

inline

Запускает асинхронную команду записи времён замка.

Аргументы

[in]	fEnabled	`true`, время задействовано.
[in]	nMinutes	Время антипассбэк в минутах.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteConfiguration()

CAsyncCommand ilg::CController::Begin_WriteConfiguration	(	const void *	pData,
		size_t	nSize
	)

inline

Запускает асинхронную команду записи конфигурации контроллера.

Аргументы

[in]	pData	Данные конфигурации.
[in]	nSize	Размер данных в байтах.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteEventReadIdx()

CAsyncCommand ilg::CController::Begin_WriteEventReadIdx ( size_t nIdx )

inline

Запускает асинхронную команду записи указателя чтения событий.

Аргументы

[in] nIdx Позиция указателя чтения событий.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteFireParams()

CAsyncCommand ilg::CController::Begin_WriteFireParams	(	uint8_t	nSrcMask,
		uint8_t	nLimitT
	)

inline

Запускает асинхронную команду записи параметров противопожарного режима.

Аргументы

[in]	nSrcMask	Маска разрешения/запрещения источников.
[in]	nLimitT	Пороговая температура.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteKeys()

CAsyncCommand ilg::CController::Begin_WriteKeys	(	uint8_t	nBankN,
		size_t	nIdx,
		const ilg_key *	pKeys,
		size_t	nCount,
		bool	fSelected = `false`
	)

inline

Запускает асинхронную команду записи ключей.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция ключа в банке ключей.
[in]	pKeys	Список ключей.
[in]	nCount	Количество ключей, которые нужно записать.
[in]	fSelected	`true`, записывать только выделенные ключи с установленным флагом ilg_key.fSelected.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteLockTimes()

CAsyncCommand ilg::CController::Begin_WriteLockTimes	(	uint8_t	nBankN,
		uint16_t	nOpen,
		uint16_t	nLet,
		uint16_t	nMax,
		bool	fBigTime
	)

inline

Запускает асинхронную команду записи времён замка.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nOpen	Время открывания замка в 1/10 секунды.
[in]	nLet	Время ожидания открытия двери в 1/10 секунды.
[in]	nMax	Время ожидания закрытия двери в 1/10 секунды.
[in]	fBigTime	`true`, используется формат большого времени 0..65535, иначе 0..255.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteMode()

CAsyncCommand ilg::CController::Begin_WriteMode ( ilg_controller_mode nMode )

inline

Запускает асинхронную команду записи режима контроллера.

Аргументы

[in] nMode Режим контроллера.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteModeTimeZones()

CAsyncCommand ilg::CController::Begin_WriteModeTimeZones	(	size_t	nIdx,
		const ilg_mode_time_zone *	pTZs,
		size_t	nCount
	)

inline

Запускает асинхронную команду записи временных зон для переключения режима контроллера.

Аргументы

[in]	nIdx	Позиция временной зоны 0..1.
[in]	pTZs	Список временных зон.
[in]	nCount	Количество записываемых временных зон 1..2.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteSecurityParams()

CAsyncCommand ilg::CController::Begin_WriteSecurityParams	(	uint8_t	nSrcMask,
		uint8_t	nTime
	)

inline

Запускает асинхронную команду записи параметров режима охраны.

Аргументы

[in]	nSrcMask	Маска разрешения/запрещения источников.
[in]	nTime	Время звучания сирены после исчезновения источника тревоги.

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

Исключения

CILGException если произошла ошибка.

◆ Begin_WriteTimeZones()

CAsyncCommand ilg::CController::Begin_WriteTimeZones	(	uint8_t	nBankN,
		size_t	nIdx,
		const ilg_time_zone *	pTZs,
		size_t	nCount
	)

inline

Запускает асинхронную команду записи временных зон.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция временной зоны в банке.
[in]	pTZs	Список временных зон.
[in]	nCount	Количество зон, которые нужно записать.

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

Исключения

CILGException если произошла ошибка.

◆ Clone()

CController ilg::CController::Clone ( ) const

inline

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

Возвращает: Дескриптор контроллера.

◆ Connect()

void ilg::CController::Connect ( bool fReconnect = false )

inline

Подключается к контроллеру.

Аргументы

[in] fReconnect true, отключается перед подключением.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp, controller_keys/main.cpp, controller_lock/main.cpp и controller_schedule/main.cpp.

◆ DecodeControllerModeEvent()

void ilg::CController::DecodeControllerModeEvent	(	const uint64_t &	nEvent,
		ilg_controller_time &	rTime,
		ilg_controller_mode &	nMode,
		uint8_t &	nFlags,
		uint8_t &	nTrigger
	)

inline

Декодирует событие переключения режима контроллера.

Аргументы

[in]	nEvent	Данные события.
[out]	rTime	Дата и время события.
[out]	nMode	Режим контроллера.
[out]	nFlags	Флаги состояния.
[out]	nTrigger	Код условия вызвавшего срабатывание.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp.

◆ DecodeEventType()

ilg_event_type ilg::CController::DecodeEventType	(	const uint64_t &	nEvent,
		ilg_event_format *	pFormat = `nullptr`
	)

inline

Определяет тип события контроллера и формат записи события.

Аргументы

[in]	nEvent	Данные события.
[out]	pFormat	Формат записи события.

Возвращает: Тип события.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp.

◆ DecodeKeyNumber()

void ilg::CController::DecodeKeyNumber	(	const uint64_t &	nEvent,
		ilg_key_number &	rKeyNumber
	)

inline

Декодирует событие с номером ключа.

Аргументы

[in]	nEvent	Данные события.
[out]	rKeyNumber	Номер ключа.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp.

◆ DecodePassageEvent()

void ilg::CController::DecodePassageEvent	(	const uint64_t &	nEvent,
		ilg_controller_time &	rTime,
		ilg_direction &	nDirection,
		uint8_t &	nKeyBankN,
		ssize_t &	nKeyIdx
	)

inline

Декодирует событие прохода.

Аргументы

[in]	nEvent	Данные события.
[out]	rTime	Дата и время события.
[out]	nDirection	Направление прохода.
[out]	nKeyBankN	Номер банка ключей.
[out]	nKeyIdx	Позиция ключа в банке ключей.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp.

◆ DecodeStateEvent()

void ilg::CController::DecodeStateEvent	(	const uint64_t &	nEvent,
		ilg_controller_time &	rTime,
		uint8_t &	nFlags,
		uint8_t &	nTrigger
	)

inline

Декодирует событие изменения состояния.

Аргументы

[in]	nEvent	Данные события.
[out]	rTime	Дата и время события.
[out]	nFlags	Флаги состояния.
[out]	nTrigger	Код условия вызвавшего срабатывание.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp.

◆ DecodeTimeEvent()

void ilg::CController::DecodeTimeEvent	(	const uint64_t &	nEvent,
		ilg_controller_time &	rTime
	)

inline

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

Аргументы

[in]	nEvent	Данные события.
[out]	rTime	Дата и время события.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp.

◆ Disconnect()

void ilg::CController::Disconnect ( )

inline

Отключается от контроллера.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ EnableMessageQueue()

void ilg::CController::EnableMessageQueue ( bool fEnable = true )

inline

Включает/выключает очередь сообщений.

Эта функция устанавливает/снимает флаг в дескрипторе контроллера. Очередь сообщений предназначена для синхронизации обработки сообщений.

Прим.: Алгоритм синхронизации: при возникновении события в очередь добавляется сообщение и вызывается функция обратного вызова, установленная функцией SetMessageCallback, из которой посылается сигнал потоку, обрабатывающему сообщения, этот поток при получении сигнала циклично вызывает GetMessage, чтобы получить и обработать все сообщения.

Аргументы

[in] fEnable true, включает очередь, иначе - выключает.

Предупреждения: Если не извлекать сообщения из очереди функцией GetMessage, то она будет расти пока не закончится память.

Исключения

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

◆ End_EraseKeys()

void ilg::CController::End_EraseKeys	(	ilg_handle	hCommand,
		size_t &	nErased
	)

inlinestatic

Возвращает результат стирания ключей.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_EraseKeys.
[out]	nErased	Количество стёртых ключей. Если функция завершилась успешно, то равно количеству стираемых ключей.

Исключения

CILGException если произошла ошибка.

◆ End_EraseKeys2()

void ilg::CController::End_EraseKeys2	(	ilg_handle	hCommand,
		size_t &	nErased
	)

inlinestatic

Возвращает результат стирания ключей в указанных ячейках.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_EraseKeys2.
[out]	nErased	Количество стёртых ключей. Если функция завершилась успешно, то равно количеству стираемых ключей.

Исключения

CILGException если произошла ошибка.

◆ End_ReadAntiCovid()

void ilg::CController::End_ReadAntiCovid	(	ilg_handle	hCommand,
		uint16_t *	pMax8,
		uint16_t *	pCount8
	)

inlinestatic

Возвращает результат чтения параметров AntiCovid.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadAntiCovid.
[out]	pMax8	Максимумы, массив из 8 элементов.
[out]	pCount8	Счётчики, массив из 8 элементов.

Исключения

CILGException если произошла ошибка.

◆ End_ReadApbTime()

void ilg::CController::End_ReadApbTime	(	ilg_handle	hCommand,
		bool &	fEnabled,
		uint16_t &	nMinutes
	)

inlinestatic

Возвращает результат чтения времени антипассбэк.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadApbTime.
[out]	fEnabled	`true`, время задействовано.
[out]	nMinutes	Время антипассбэк в минутах.

Исключения

CILGException если произошла ошибка.

◆ End_ReadConfiguration()

void ilg::CController::End_ReadConfiguration	(	ilg_handle	hCommand,
		std::vector< uint8_t > &	oData
	)

static

Возвращает результат чтения конфигурации контроллера.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadConfiguration.
[out]	oData	Данные конфигурации.

Исключения

CILGException если произошла ошибка.

◆ End_ReadEcParams()

void ilg::CController::End_ReadEcParams	(	ilg_handle	hCommand,
		uint8_t &	nPowerConfig,
		uint8_t &	nDelay,
		uint8_t *	pState = `nullptr`
	)

inlinestatic

Возвращает результат чтения параметров режима ЭлектроКонтроль.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadEcParams.
[out]	nPowerConfig	Флаги конфигурации режима.
[out]	nDelay	Время задержки в секундах.
[out]	pState	Флаги состояния.

Исключения

CILGException если произошла ошибка.

◆ End_ReadEvents()

void ilg::CController::End_ReadEvents	(	ilg_handle	hCommand,
		const uint64_t *&	pList,
		size_t &	nRead
	)

inlinestatic

Возвращает результат чтения событий.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadEvents.
[out]	pList	Ссылка на список прочитанных событий. Ссылка действительна до закрытия дескриптора команды.
[out]	nRead	Количество прочитанных событий. Если функция завершилась успешно, то равно количеству запрошенных событий.

Исключения

CILGException если произошла ошибка.

◆ End_ReadExtAskParams()

void ilg::CController::End_ReadExtAskParams	(	ilg_handle	hCommand,
		ilg_extask_params &	rParams
	)

inlinestatic

Возвращает результат чтения параметров ExtAsk.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadExtAskParams.
[out]	rParams	Параметры ExtAsk.

Исключения

CILGException если произошла ошибка.

◆ End_ReadFireParams()

void ilg::CController::End_ReadFireParams	(	ilg_handle	hCommand,
		uint8_t &	nSrcMask,
		uint8_t &	nLimitT,
		uint8_t &	nState,
		uint8_t &	nT
	)

inlinestatic

Возвращает результат чтения параметров противопожарного режима.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadFireParams.
[out]	nSrcMask	Маска разрешения/запрещения источников.
[out]	nLimitT	Пороговая температура.
[out]	nState	Флаги состояния.
[out]	nT	Текущая температура.

Исключения

CILGException если произошла ошибка.

◆ End_ReadKeys()

void ilg::CController::End_ReadKeys	(	ilg_handle	hCommand,
		const ilg_key *&	pList,
		size_t &	nRead
	)

inlinestatic

Возвращает результат чтения ключей.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadKeys.
[out]	pList	Ссылка на массив прочитанных ключей. Ссылка действительна до закрытия дескриптора команды.
[out]	nRead	Количество прочитанных ключей. Если команда выполнена успешно, то равно количеству запрошенных ключей.

Исключения

CILGException если произошла ошибка.

◆ End_ReadKeyTopIdx()

void ilg::CController::End_ReadKeyTopIdx	(	ilg_handle	hCommand,
		ssize_t &	nIdx
	)

inlinestatic

Возвращает результат чтения верхней границы ключей.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadKeyTopIdx.
[out]	nIdx	Позиция верхней границы ключей. Если равно -1, то в контроллере адрес верхней границы не корректный.

Исключения

CILGException если произошла ошибка.

◆ End_ReadLines()

void ilg::CController::End_ReadLines	(	ilg_handle	hCommand,
		std::string &	sLines
	)

static

Возвращает результат чтения инфо строк контроллера.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadLines.
[out]	sLines	Строки контроллера.

Исключения

CILGException если произошла ошибка.

◆ End_ReadLockTimes()

void ilg::CController::End_ReadLockTimes	(	ilg_handle	hCommand,
		uint16_t &	nOpen,
		uint16_t &	nLet,
		uint16_t &	nMax,
		bool &	fBigTime
	)

inlinestatic

Возвращает результат чтения времён замка.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadLockTimes.
[out]	nOpen	Время открывания замка в 1/10 секунды.
[out]	nLet	Время ожидания открытия двери в 1/10 секунды.
[out]	nMax	Время ожидания закрытия двери в 1/10 секунды.
[out]	fBigTime	`true`, используется формат большого времени 0..65535, иначе 0..255.

Исключения

CILGException если произошла ошибка.

◆ End_ReadMode()

void ilg::CController::End_ReadMode	(	ilg_handle	hCommand,
		ilg_controller_mode &	nMode,
		uint8_t *	pFlags = `nullptr`
	)

inlinestatic

Возвращает результат чтения режима контроллера.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadMode.
[out]	nMode	Режим контроллера.
[out]	pFlags	Флаги активизации.

Исключения

CILGException если произошла ошибка.

◆ End_ReadModeTimZones()

void ilg::CController::End_ReadModeTimZones	(	ilg_handle	hCommand,
		const ilg_mode_time_zone *&	pList,
		size_t &	nRead
	)

inlinestatic

Возвращает результат чтения временных зон для переключения режима контроллера.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadModeTimZones.
[out]	pList	Ссылка на список прочитанных временных зон. Ссылка действительна до закрытия дескриптора команды `hCommand`.
[out]	nRead	Количество прочитанных временных зон. Равно количеству запрошенных зон.

Исключения

CILGException если произошла ошибка.

◆ End_ReadRtcParams()

void ilg::CController::End_ReadRtcParams	(	ilg_handle	hCommand,
		ilg_rtc_params &	rParams
	)

inlinestatic

Возвращает результат чтения параметров RTC.

Аргументы

[in]	hCommand	Дескриптор команды, которую вернула Begin_ReadRtcParams.
[out]	rParams	Параметры RTC.

Исключения

CILGException если произошла ошибка.

◆ End_ReadSecurityParams()

void ilg::CController::End_ReadSecurityParams	(	ilg_handle	hCommand,
		uint8_t &	nSrcMask,
		uint8_t &	nTime,
		uint8_t &	nState
	)

inlinestatic

Возвращает результат чтения параметров режима охраны.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_ReadSecurityParams.
[out]	nSrcMask	Маска разрешения/запрещения источников.
[out]	nTime	Время звучания сирены после исчезновения источника тревоги.
[out]	nState	Флаги состояния.

Исключения

CILGException если произошла ошибка.

◆ End_ReadTimeZones()

void ilg::CController::End_ReadTimeZones	(	ilg_handle	hCommand,
		const ilg_time_zone *&	pList,
		size_t &	nRead
	)

inlinestatic

Возвращает результат чтения временных зон.

Аргументы

[in]	hCommand	Дескриптор команды.
[out]	pList	Ссылка на список прочитанных временных зон. Ссылка действительна до закрытия дескриптора команды `hCommand`.
[out]	nRead	Количество прочитанных временных зон. Если команда выполнена успешно, то равно запрошенному количеству временных зон.

Исключения

CILGException если произошла ошибка.

◆ End_WriteFireParams()

void ilg::CController::End_WriteFireParams	(	ilg_handle	hCommand,
		uint8_t &	nState,
		uint8_t &	nT
	)

inlinestatic

Возвращает результат записи параметров противопожарного режима.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_WriteFireParams.
[out]	nState	Флаги состояния.
[out]	nT	Текущая температура.

Исключения

CILGException если произошла ошибка.

◆ End_WriteKeys()

void ilg::CController::End_WriteKeys	(	ilg_handle	hCommand,
		size_t &	nWritten
	)

inlinestatic

Возвращает результат записи ключей.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_WriteKeys.
[out]	nWritten	Количество записанных ключей. Если команда выполнена успешно, то равно количеству записываемых ключей.

Исключения

CILGException если произошла ошибка.

◆ End_WriteSecurityParams()

void ilg::CController::End_WriteSecurityParams	(	ilg_handle	hCommand,
		uint8_t &	nState
	)

inlinestatic

Возвращает результат записи параметров режима охраны.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_WriteSecurityParams.
[out]	nState	Флаги состояния.

Исключения

CILGException если произошла ошибка.

◆ End_WriteTimeZones()

void ilg::CController::End_WriteTimeZones	(	ilg_handle	hCommand,
		size_t &	nWritten
	)

inlinestatic

Возвращает результат записи временных зон.

Аргументы

[in]	hCommand	Дескриптор команды, который вернула Begin_WriteTimeZones.
[out]	nWritten	Количество записанных зон. Если функция выполнена успешно, то равно количеству записываемых временных зон.

Исключения

CILGException если произошла ошибка.

◆ EraseKeys()

void ilg::CController::EraseKeys	(	uint8_t	nBankN,
		size_t	nIdx,
		size_t	nCount,
		size_t *	pErased = `nullptr`
	)

inline

Стирает ключи в памяти контроллера.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция ключа в банке ключей.
[in]	nCount	Количество ключей, которые нужно стереть.
[out]	pErased	Количество стёртых ключей. Если функция завершилась успешно, то всегда равно `nCount`.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_keys/main.cpp.

◆ EraseKeys2()

void ilg::CController::EraseKeys2	(	uint8_t	nBankN,
		const size_t *	pIdxs,
		size_t	nCount,
		size_t *	pErased = `nullptr`
	)

inline

Стирает ключи в указанных ячейках.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	pIdxs	Список позиций ключей, сортированный по возрастанию.
[in]	nCount	Количество ключей, которые нужно стереть.
[out]	pErased	Количество стёртых ключей. Если функция завершилась успешно, то всегда равно `nCount`.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ GetConnectionStatus()

ilg_connection_status ilg::CController::GetConnectionStatus ( ) const

inline

Возвращает состояние подключения к контроллеру.

Возвращает: Состояние подключения к контроллеру.

Исключения

CILGException если произошла ошибка.

◆ GetControllerInfo()

void ilg::CController::GetControllerInfo ( ilg_controller_info & rInfo ) const

inline

Возвращает информацию о контроллере.

Аргументы

[out] rInfo Информация о контроллере.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp, controller_keys/main.cpp, controller_lock/main.cpp и controller_schedule/main.cpp.

◆ GetConverter()

CConverter ilg::CController::GetConverter ( ) const

inline

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

Возвращает: Новый дескриптор конвертера.

◆ GetConverterInfo()

void ilg::CController::GetConverterInfo ( ilg_converter_info & rInfo ) const

inline

Возвращает информацию о конвертере.

Аргументы

[out] rInfo Информация о конвертере.

Исключения

CILGException если произошла ошибка.

◆ GetExtAskParams()

void ilg::CController::GetExtAskParams ( ilg_extask_params & rParams )

inline

Возвращает результат авто опроса ExtAsk.

Аргументы

[out] rParams Параметры ExtAsk.

Исключения

CILGException если произошла ошибка.

◆ GetMessage()

bool ilg::CController::GetMessage	(	ilg_controller_msg &	nMsg,
		const void *&	pMsgData
	)		const

inline

Извлекает следующее сообщение из очереди.

Аргументы

[out]	nMsg	Тип сообщения.
[out]	pMsgData	Указатель на данные пользователя, которые были установлены функцией SetMessageCallback.

Возвращает: true если сообщение успешно извлечено, иначе - очередь пуста.

Исключения

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

◆ GetOptions()

void ilg::CController::GetOptions ( ilg_controller_options & rOptions )

inline

Возвращает параметры контроллера.

Аргументы

[out] rOptions Параметры контроллера.

Исключения

CILGException если произошла ошибка `ILG_E_HANDLE`, `ILG_E_POINTER`.

◆ GetRtcParams()

void ilg::CController::GetRtcParams ( ilg_rtc_params & rParams )

inline

Возвращает результат авто опроса параметров RTC.

Аргументы

[out] rParams Параметры RTC.

Исключения

CILGException если произошла ошибка.

◆ OpenDoor()

void ilg::CController::OpenDoor ( bool fOut )

inline

Открывает дверь.

Аргументы

[in] fOut true, открывает для выхода, иначе - для входа.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp и controller_lock/main.cpp.

◆ ReadAntiCovid()

void ilg::CController::ReadAntiCovid	(	uint16_t *	pMax8,
		uint16_t *	pCount8
	)

inline

Читает параметры AntiCovid.

Аргументы

[out]	pMax8	Максимумы, массив из 8 элементов.
[out]	pCount8	Счётчики, массив из 8 элементов.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ ReadApbTime()

void ilg::CController::ReadApbTime	(	bool &	fEnabled,
		uint16_t &	nMinutes
	)

inline

Читает время антипассбэк из контроллера.

Аргументы

[out]	fEnabled	`true`, время задействовано.
[out]	nMinutes	Время антипассбэк в минутах.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ ReadConfiguration()

void ilg::CController::ReadConfiguration ( std::vector< uint8_t > & oData )

Читает конфигурацию контроллера.

Аргументы

[out] oData Данные конфигурации.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ ReadEcParams()

void ilg::CController::ReadEcParams	(	uint8_t &	nPowerConfig,
		uint8_t &	nDelay,
		uint8_t *	pState = `nullptr`
	)

inline

Читает параметры режима ЭлектроКонтроль.

Аргументы

[out]	nPowerConfig	Флаги конфигурации режима. Бит 0 (ILG_ECPC_F_ENABLED) Управление питанием включено. Бит 1 (ILG_ECPC_F_SCHEDULE) Использовать временную зону 6 для включения питания. Бит 2 (ILG_ECPC_F_EXT_READER) Контрольный считыватель: «0» Matrix-II Net, «1» внешний считыватель. Бит 3 (ILG_ECPC_F_INVERT) Инвертировать управляющий выход. Бит 3 (ILG_ECPC_F_INVERT) Инвертировать управляющий выход. Бит 4 (ILG_ECPC_F_EXIT_OFF) Задействовать датчик двери. Бит 5 (ILG_ECPC_F_CARD_OPEN) Не блокировать функцию открывания для контрольного считывателя.
[out]	nDelay	Время задержки в секундах.
[out]	pState	Флаги состояния. Бит 0 - питание включено. Бит 1 - активно включение по временной зоне. Бит 2 - включено командой по сети Бит 3 - идет отработка задержки. Бит 4 - карта в поле контрольного считывателя.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ ReadEvents()

void ilg::CController::ReadEvents	(	size_t	nIdx,
		uint64_t *	pBuf,
		size_t	nCount,
		size_t *	pRead = `nullptr`
	)

inline

Читает события из памяти контроллера.

Аргументы

[in]	nIdx	Позиция события в банке событий.
[out]	pBuf	Буфер для событий.
[in]	nCount	Количество событий, которые нужно прочитать.
[out]	pRead	Количество прочитанных событий. Если функция завершилась успешно, то всегда равно `nCount`.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера. Получить позиции указателя чтения и указателя записи можно с помощью функции ReadRtcParams.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp.

◆ ReadExtAskParams()

void ilg::CController::ReadExtAskParams ( ilg_extask_params & rParams )

inline

Читает параметры ExtAsk из контроллера.

Аргументы

[out] rParams Параметры ExtAsk.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ ReadFireParams()

void ilg::CController::ReadFireParams	(	uint8_t &	nSrcMask,
		uint8_t &	nLimitT,
		uint8_t &	nState,
		uint8_t &	nT
	)

inline

Читает параметры противопожарного режима.

Аргументы

[out]	nSrcMask	Маска разрешения/запрещения источников. Бит 0 - разрешен пожарный режим по входу FIRE. Бит 1 - разрешен пожарный режим по превышению температуры.
[out]	nLimitT	Пороговая температура.
[out]	nState	Флаги состояния. Бит 0 - пожарный режим включён. Бит 1 - активен пожарный режим по входу FIRE. Бит 2 - активен пожарный режим по превышению температуры. Бит 3 - активен пожарный режим по внешней команде.
[out]	nT	Текущая температура.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ ReadKeys()

void ilg::CController::ReadKeys	(	uint8_t	nBankN,
		size_t	nIdx,
		ilg_key *	pBuf,
		size_t	nCount,
		size_t *	pRead = `nullptr`
	)

inline

Читает ключи из памяти контроллера.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция ключа в банке ключей.
[out]	pBuf	Буфер для ключей.
[in]	nCount	Количество ключей, которые нужно прочитать.
[out]	pRead	Количество прочитанных ключей. Если функция завершилась успешно, то всегда равно `nCount`.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp и controller_keys/main.cpp.

◆ ReadKeyTopIdx()

ssize_t ilg::CController::ReadKeyTopIdx ( uint8_t nBankN )

inline

Читает верхнюю границу ключей.

Читает из контроллера позицию верхней границы ключей, начиная с которой все ячейки стёрты.

Аргументы

[in] nBankN Номер банка: =0 вход, =1 выход.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Возвращает: Позиция верхней границы ключей. Если равно -1, то в контроллере адрес верхней границы не корректный.

Исключения

CILGException если произошла ошибка.

Примеры: controller_keys/main.cpp.

◆ ReadLines()

std::string ilg::CController::ReadLines ( )

Читает информационные строки контроллера.

Возвращает: Информационные строки контроллера.

Исключения

CILGException если произошла ошибка.

◆ ReadLockTimes()

void ilg::CController::ReadLockTimes	(	uint8_t	nBankN,
		uint16_t &	nOpen,
		uint16_t &	nLet,
		uint16_t &	nMax,
		bool &	fBigTime
	)

inline

Читает времена замка из памяти контроллера.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[out]	nOpen	Время открывания замка в 1/10 секунды.
[out]	nLet	Время ожидания открытия двери в 1/10 секунды.
[out]	nMax	Время ожидания закрытия двери в 1/10 секунды.
[out]	fBigTime	`true`, используется формат большого времени 0..65535, иначе 0..255.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_lock/main.cpp.

◆ ReadMode()

ilg_controller_mode ilg::CController::ReadMode ( uint8_t * pFlags = nullptr )

inline

Читает режим контроллера.

Возвращает текущий режим контроллера.

Аргументы

[out] pFlags Флаги активизации.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Возвращает: Режим контроллера.

Исключения

CILGException если произошла ошибка.

◆ ReadModeTimeZones()

void ilg::CController::ReadModeTimeZones	(	size_t	nIdx,
		ilg_mode_time_zone *	pBuf,
		size_t	nCount
	)

inline

Читает временные зоны для переключения режима контроллера.

Читает из памяти контроллера временные зоны для переключения режима контроллера.

Аргументы

[in]	nIdx	Позиция временной зоны 0..1.
[out]	pBuf	Буфер для временных зон.
[in]	nCount	Количество считываемых временных зон 1..2.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_schedule/main.cpp.

◆ ReadRtcParams()

void ilg::CController::ReadRtcParams ( ilg_rtc_params & rParams )

inline

Читает параметры RTC из контроллера.

Аргументы

[out] rParams Параметры RTC.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_events/main.cpp, controller_keys/main.cpp, controller_lock/main.cpp и controller_schedule/main.cpp.

◆ ReadSecurityParams()

void ilg::CController::ReadSecurityParams	(	uint8_t &	nSrcMask,
		uint8_t &	nTime,
		uint8_t &	nState
	)

inline

Читает параметры режима охраны.

Аргументы

[out]	nSrcMask	Маска разрешения/запрещения источников. Бит 0 - разрешена тревога по входу ALARM. Бит 1 - разрешена тревога по тамперу. Бит 2 - разрешена тревога по датчику двери.
[out]	nTime	Время звучания сирены после исчезновения источника тревоги.
[out]	nState	Флаги состояния. Бит 0 - охранный режим включён. Бит 1 - тревога включена. Бит 2 - тревога по входу ALARM. Бит 3 - тревога по тамперу. Бит 4 - тревога по датчику двери. Бит 5 - тревога включена по сети.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ ReadTimeZones()

void ilg::CController::ReadTimeZones	(	uint8_t	nBankN,
		size_t	nIdx,
		ilg_time_zone *	pBuf,
		size_t	nCount,
		size_t *	pRead = `nullptr`
	)

inline

Читает временные зоны из контроллера.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция временной зоны в банке.
[out]	pBuf	Буфер для временных зон.
[in]	nCount	Количество зон, которые нужно прочитать.
[out]	pRead	Количество прочитанных временных зон. Если функция завершилась успешно, то всегда равно `nCount`.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_schedule/main.cpp.

◆ SetAlarmMode()

void ilg::CController::SetAlarmMode ( bool fOn )

inline

Вкл/выкл режим тревоги.

Аргументы

[in] fOn true, включить режим.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ SetEcPower()

void ilg::CController::SetEcPower ( bool fOn )

inline

Вкл/выкл питание в режиме Электроконтроль.

Аргументы

[in] fOn true, включить питание.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ SetEmergencyMode()

void ilg::CController::SetEmergencyMode ( bool fEnable )

inline

Вкл/выкл старый режим аварийного открывания дверей.

Аргументы

[in] fEnable true, включить аварийный режим.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_lock/main.cpp.

◆ SetFireMode()

void ilg::CController::SetFireMode ( bool fOn )

inline

Вкл/выкл противопожарный режим.

Аргументы

[in] fOn true, включить режим.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ SetFirmware()

void ilg::CController::SetFirmware	(	const void *	pData,
		size_t	nSize
	)

inline

Устанавливает прошивку контроллера.

Аргументы

[in]	pData	Данные прошивки.
[in]	nSize	Размер данных прошивки в байтах.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ SetMessageCallback()

void ilg::CController::SetMessageCallback	(	ilg_controller_message_callback	pCallback,
		void *	pUserData = `nullptr`
	)

inline

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

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

Аргументы

[in]	pCallback	Указатель на функцию, которую библиотека будет вызывать при возникновении события контроллера.
[in]	pUserData	Указатель на данные пользователя, который будет передаваться в функцию.

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

Исключения

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

Примеры: controller_events/main.cpp.

◆ SetNetworkAddress()

void ilg::CController::SetNetworkAddress ( uint8_t nAddress )

inline

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

Аргументы

[in] nAddress Адрес контроллера 0..254.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера. Работает только в режиме Normal конвертера или с Z-397 Guard.

Исключения

CILGException если произошла ошибка.

◆ SetOptions()

void ilg::CController::SetOptions ( const ilg_controller_options & rOptions )

inline

Устанавливает параметры контроллера.

Аргументы

[in] rOptions Параметры контроллера.

Исключения

CILGException если произошла ошибка `ILG_E_HANDLE`, `ILG_E_INVALIDARG`.

◆ SetSecurityMode()

void ilg::CController::SetSecurityMode ( bool fOn )

inline

Вкл/выкл режим охраны.

Аргументы

[in] fOn true, включить режим.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ SyncClock()

void ilg::CController::SyncClock ( )

inline

Синхронизирует часы контроллера с часами ПК.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера. Получить текущее время контроллера можно с помощью функции ReadRtcParams.

Исключения

CILGException если произошла ошибка.

Примеры: controller_schedule/main.cpp.

◆ WriteAntiCovid()

void ilg::CController::WriteAntiCovid ( const uint16_t * pMax8 )

inline

Пишет максимумы AntiCovid.

Аргументы

[in] pMax8 Максимумы, массив из 8 элементов.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ WriteApbTime()

void ilg::CController::WriteApbTime	(	bool	fEnabled,
		uint16_t	nMinutes
	)

inline

Пишет время антипассбэк в контроллер.

Аргументы

[in]	fEnabled	`true`, время задействовано.
[in]	nMinutes	Время антипассбэк в минутах.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ WriteConfiguration()

void ilg::CController::WriteConfiguration	(	const void *	pData,
		size_t	nSize
	)

inline

Пишет конфигурацию контроллера.

Аргументы

[in]	pData	Данные конфигурации.
[in]	nSize	Размер данных в байтах.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера. Данные конфигурации можно получить с помощью ПО GuardLight.

Исключения

CILGException если произошла ошибка.

◆ WriteEventReadIdx()

void ilg::CController::WriteEventReadIdx ( size_t nIdx )

inline

Пишет позицию указателя чтения событий.

Аргументы

[in] nIdx Позиция указателя чтения событий.

Исключения

CILGException если произошла ошибка.

◆ WriteFireParams()

void ilg::CController::WriteFireParams	(	uint8_t	nSrcMask,
		uint8_t	nLimitT,
		uint8_t *	pState = `nullptr`,
		uint8_t *	pT = `nullptr`
	)

inline

Пишет параметры противопожарного режима.

Аргументы

[in]	nSrcMask	Маска разрешения/запрещения источников.
[in]	nLimitT	Пороговая температура.
[out]	pState	Флаги состояния.
[out]	pT	Текущая температура.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ WriteKeys()

void ilg::CController::WriteKeys	(	uint8_t	nBankN,
		size_t	nIdx,
		const ilg_key *	pKeys,
		size_t	nCount,
		size_t *	pWritten = `nullptr`,
		bool	fSelected = `false`
	)

inline

Пишет ключи в память контроллера.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция ключа в банке ключей.
[in]	pKeys	Список ключей.
[in]	nCount	Количество ключей, которые нужно записать.
[out]	pWritten	Количество записанных ключей. Если функция завершилась успешно, то всегда равно `nCount`.
[in]	fSelected	`true`, записывать только выделенные ключи с установленным флагом fSelected в ilg_key.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Предупреждения: В режиме Advanced конвертера действует лицензия (

См. также: ilg_license_info), которая может ограничивать до какой позиции можно записывать ключи.

Исключения

CILGException если произошла ошибка.

Примеры: controller_keys/main.cpp.

◆ WriteLockTimes()

void ilg::CController::WriteLockTimes	(	uint8_t	nBankN,
		uint16_t	nOpen,
		uint16_t	nLet,
		uint16_t	nMax,
		bool	fBigTime
	)

inline

Пишет времена замка в память контроллера.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nOpen	Время открывания замка в 1/10 секунды.
[in]	nLet	Время ожидания открытия двери в 1/10 секунды.
[in]	nMax	Время ожидания закрытия двери в 1/10 секунды.
[in]	fBigTime	`true`, используется формат большого времени 0..65535, иначе 0..255.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_lock/main.cpp.

◆ WriteMode()

void ilg::CController::WriteMode ( ilg_controller_mode nMode )

inline

Пишет режим контроллера.

Устанавливает в контроллер текущий режим контроллера.

Аргументы

[in] nMode Режим контроллера.

Исключения

CILGException если произошла ошибка.

◆ WriteModeTimeZones()

void ilg::CController::WriteModeTimeZones	(	size_t	nIdx,
		const ilg_mode_time_zone *	pTZs,
		size_t	nCount
	)

inline

Пишет временные зоны для переключения режима контроллера.

Пишет в память контроллера временные зоны для переключения режима контроллера.

Аргументы

[in]	nIdx	Позиция временной зоны 0..1.
[in]	pTZs	Список временных зон.
[in]	nCount	Количество записываемых временных зон 1..2.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ WriteSecurityParams()

void ilg::CController::WriteSecurityParams	(	uint8_t	nSrcMask,
		uint8_t	nTime,
		uint8_t *	pState = `nullptr`
	)

inline

Пишет параметры режима охраны.

Аргументы

[in]	nSrcMask	Маска разрешения/запрещения источников.
[in]	nTime	Время звучания сирены после исчезновения источника тревоги.
[out]	pState	Флаги состояния.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

◆ WriteTimeZones()

void ilg::CController::WriteTimeZones	(	uint8_t	nBankN,
		size_t	nIdx,
		const ilg_time_zone *	pTZs,
		size_t	nCount,
		size_t *	pWritten = `nullptr`
	)

inline

Пишет временные зоны в контроллер.

Аргументы

[in]	nBankN	Номер банка: =0 вход, =1 выход.
[in]	nIdx	Позиция временной зоны в банке.
[in]	pTZs	Список временных зон.
[in]	nCount	Количество зон, которые нужно записать.
[out]	pWritten	Количество записанных зон. Если команда выполнена успешно, то равно количеству временных зон `nCount`.

Прим.: Функция не возвращает управление пока ждёт выполнение команды в потоке конвертера.

Исключения

CILGException если произошла ошибка.

Примеры: controller_schedule/main.cpp.

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

ilg_cpp_helpers.h
ilg_cpp_helpers.cpp

	SDK Guard 1.0.2 SDK для связи с сетевыми контроллерами Iron logic

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

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

Дополнительные унаследованные члены

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

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

◆ CController() [1/2]

◆ CController() [2/2]

Методы

◆ Begin_Connect()

◆ Begin_Disconnect()

◆ Begin_EraseKeys()

◆ Begin_EraseKeys2()

◆ Begin_OpenDoor()

◆ Begin_ReadAntiCovid()

◆ Begin_ReadApbTime()

◆ Begin_ReadConfiguration()

◆ Begin_ReadEcParams()

◆ Begin_ReadEvents()

◆ Begin_ReadExtAskParams()

◆ Begin_ReadFireParams()

◆ Begin_ReadKeys()

◆ Begin_ReadKeyTopIdx()

◆ Begin_ReadLines()

◆ Begin_ReadLockTimes()

◆ Begin_ReadMode()

◆ Begin_ReadModeTimZones()

◆ Begin_ReadRtcParams()

◆ Begin_ReadSecurityParams()

◆ Begin_ReadTimeZones()

◆ Begin_SetAlarmMode()

◆ Begin_SetEcPower()

◆ Begin_SetEmergencyMode()

◆ Begin_SetFireMode()

◆ Begin_SetFirmware()

◆ Begin_SetNetworkAddress()

◆ Begin_SetSecurityMode()

◆ Begin_SyncClock()

◆ Begin_WriteAntiCovid()

◆ Begin_WriteApbTime()

◆ Begin_WriteConfiguration()

◆ Begin_WriteEventReadIdx()

◆ Begin_WriteFireParams()

◆ Begin_WriteKeys()

◆ Begin_WriteLockTimes()

◆ Begin_WriteMode()

◆ Begin_WriteModeTimeZones()

◆ Begin_WriteSecurityParams()

◆ Begin_WriteTimeZones()

◆ Clone()

◆ Connect()

◆ DecodeControllerModeEvent()

◆ DecodeEventType()

◆ DecodeKeyNumber()

◆ DecodePassageEvent()

◆ DecodeStateEvent()

◆ DecodeTimeEvent()

◆ Disconnect()

◆ EnableMessageQueue()

◆ End_EraseKeys()

◆ End_EraseKeys2()

◆ End_ReadAntiCovid()

◆ End_ReadApbTime()

◆ End_ReadConfiguration()

◆ End_ReadEcParams()

◆ End_ReadEvents()

◆ End_ReadExtAskParams()

◆ End_ReadFireParams()

◆ End_ReadKeys()

◆ End_ReadKeyTopIdx()

◆ End_ReadLines()

◆ End_ReadLockTimes()

◆ End_ReadMode()

◆ End_ReadModeTimZones()

◆ End_ReadRtcParams()

◆ End_ReadSecurityParams()

◆ End_ReadTimeZones()

◆ End_WriteFireParams()

◆ End_WriteKeys()

◆ End_WriteSecurityParams()

◆ End_WriteTimeZones()