MBee Arduino library
Открытые члены | Полный список членов класса
Класс PayloadRequest

Базовый класс для всех пакетов, предназначенных для передачи по эфиру неструктурированных данных. Подробнее...

#include <SerialStar.h>

Граф наследования:PayloadRequest:
MBeeRequest TxRequest

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

 PayloadRequest (uint8_t apiId, uint8_t frameId, uint8_t *payload, uint8_t payloadLength)
 
uint8_t * getPayload ()
 Возвращает указатель на поле данных.
 
void setPayload (uint8_t *payloadPtr)
 Устанавливает указатель на поле данных.
 
void setPayload (uint8_t *payloadPtr, uint8_t payloadLength)
 Уставливает инлайном одновременно указатель на поле данных и число байт из него, начиная с первого, которое требуется поместить в передаваемое сообщение.
 
uint8_t getPayloadLength ()
 Возвращает установленную длину поля данных.
 
void setPayloadLength (uint8_t payloadLength)
 Устанавливает число байт, которое надо поместить в поле данных отправляемого пакета. Подробнее...
 
- Открытые члены унаследованные от MBeeRequest
 MBeeRequest (uint8_t apiId, uint8_t frameId)
 Конструктор, создающий фрейм с заданным API ID и идентификатором.
 
void setFrameId (uint8_t frameId)
 Устанавливает frame id. Подробнее...
 
uint8_t getFrameId ()
 Возвращает frame id.
 
void setApiId (uint8_t apiId)
 Устанавливает тип API-фрейма.
 
uint8_t getApiId ()
 Возвращает тип API-фрейма.
 
virtual uint8_t getFrameData (uint8_t pos)=0
 Возвращает буфер, который содержит сообщение. Подробнее...
 
virtual uint8_t getFrameDataLength ()=0
 Возвращает длину поля данных фрейма, не включая frame id или api id и checksum.
 

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

Базовый класс для всех пакетов, предназначенных для передачи по эфиру неструктурированных данных.

См. определение в файле SerialStar.h строка 828

Методы

◆ setPayloadLength()

void PayloadRequest::setPayloadLength ( uint8_t  payloadLength)

Устанавливает число байт, которое надо поместить в поле данных отправляемого пакета.

Например, если буфер, на который указывает указатель, установленный функцией setPayload(), содержит 40 байт, а требуется передать только первые 5, то вызывается эта функция с параметром 5. Значение параметра не должно превышать длину буфера.

См. определение в файле SerialStar.cpp строка 717

718 {
719  _payloadLength = payloadLength;
720 }

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