BayEOS-Arduino  1.8.0_0.0.4
Public Member Functions | List of all members
RxDataResponse Class Referenceabstract

#include <XBee.h>

Inheritance diagram for RxDataResponse:
XBeeResponse RxResponse ZBRxResponse Rx16Response Rx64Response RxIoSampleBaseResponse ZBRxIoSampleResponse Rx16IoSampleResponse Rx64IoSampleResponse

Public Member Functions

uint8_t getData (int index)
 
uint8_t * getData ()
 
virtual uint8_t getDataLength ()=0
 
virtual uint8_t getDataOffset ()=0
 
- Public Member Functions inherited from XBeeResponse
 XBeeResponse ()
 
uint8_t getApiId ()
 
void setApiId (uint8_t apiId)
 
uint8_t getMsbLength ()
 
void setMsbLength (uint8_t msbLength)
 
uint8_t getLsbLength ()
 
void setLsbLength (uint8_t lsbLength)
 
uint8_t getChecksum ()
 
void setChecksum (uint8_t checksum)
 
uint8_t getFrameDataLength ()
 
void setFrameData (uint8_t *frameDataPtr)
 
uint8_t * getFrameData ()
 
void setFrameLength (uint8_t frameLength)
 
uint16_t getPacketLength ()
 
void reset ()
 
void init ()
 
void getZBTxStatusResponse (XBeeResponse &response)
 
void getZBRxResponse (XBeeResponse &response)
 
void getZBRxIoSampleResponse (XBeeResponse &response)
 
void getTxStatusResponse (XBeeResponse &response)
 
void getRx16Response (XBeeResponse &response)
 
void getRx64Response (XBeeResponse &response)
 
void getRx16IoSampleResponse (XBeeResponse &response)
 
void getRx64IoSampleResponse (XBeeResponse &response)
 
void getAtCommandResponse (XBeeResponse &responses)
 
void getRemoteAtCommandResponse (XBeeResponse &response)
 
void getModemStatusResponse (XBeeResponse &response)
 
bool isAvailable ()
 
void setAvailable (bool complete)
 
bool isError ()
 
uint8_t getErrorCode ()
 
void setErrorCode (uint8_t errorCode)
 

Additional Inherited Members

- Protected Attributes inherited from XBeeResponse
uint8_t * _frameDataPtr
 

Detailed Description

Common functionality for both Series 1 and 2 data RX data packets

Definition at line 336 of file XBee.h.

Member Function Documentation

◆ getData() [1/2]

uint8_t RxDataResponse::getData ( int  index)

Returns the specified index of the payload. The index may be 0 to getDataLength() - 1 This method is deprecated; use uint8_t* getData()

Definition at line 650 of file XBee.cpp.

◆ getData() [2/2]

uint8_t * RxDataResponse::getData ( void  )

Returns the payload array. This may be accessed from index 0 to getDataLength() - 1

Definition at line 654 of file XBee.cpp.

◆ getDataLength()

virtual uint8_t RxDataResponse::getDataLength ( )
pure virtual

Returns the length of the payload

Implemented in RxResponse, and ZBRxResponse.

◆ getDataOffset()

virtual uint8_t RxDataResponse::getDataOffset ( )
pure virtual

Returns the position in the frame data where the data begins

Implemented in RxResponse, and ZBRxResponse.


The documentation for this class was generated from the following files: