IPayloadResponse.h

00001 #ifndef UK_AC_HERTS_SMARTLAB_XBEE_IPayloadResponse
00002 #define UK_AC_HERTS_SMARTLAB_XBEE_IPayloadResponse
00003 
00004 #include "Address.h"
00005 
00006 class IPayloadResponse
00007 {
00008 public:
00009     /**
00010     * bit mask
00011     * SUCCESS = 0x00,
00012     * PACKET_ACKNOWLEDGED = 0x01,
00013     * PACKET_WAS_A_BROADCAST = 0x02,
00014     * PACKET_RECEIVED_ON_BOARDCAST_PAN = 0x04,
00015     * PACKET_ENCRYPTED_WITH_APS_ENCRYPTION = 0x20,
00016     * PACKET_WAS_SENT_FROM_AN_END_DEVICE = 0x40,
00017     */
00018     virtual int getReceiveStatus() = 0;
00019 
00020     virtual Address getRemoteDevice() = 0;
00021 
00022     virtual unsigned  char * getReceivedData() = 0;
00023 
00024     virtual int getReceivedDataOffset() = 0;
00025 
00026     virtual char getReceivedData(int index) = 0;
00027 
00028     virtual int getReceivedDataLength() = 0;
00029 
00030     /// <summary>
00031     /// not apply to ZigBee
00032     /// </summary>
00033     /// <returns></returns>
00034     virtual int getRSSI() = 0;
00035 };
00036 
00037 #endif