ZigBeeTxStatusIndicator.h

00001 #ifndef UK_AC_HERTS_SMARTLAB_XBEE_ZigBeeTxStatusIndicator
00002 #define UK_AC_HERTS_SMARTLAB_XBEE_ZigBeeTxStatusIndicator
00003 
00004 #include "RxBase.h"
00005 #include "ITransmitStatus.h"
00006 
00007 class ZigBeeTxStatusIndicator: public ITransmitStatus, public RxBase
00008 {
00009 public:
00010     ZigBeeTxStatusIndicator(APIFrame * frame);
00011 
00012     virtual int getFrameID();
00013 
00014     /**
00015        *SUCCESS = 0x00,
00016        *        MAC_ACK_FAILURE = 0x01,
00017        *        CCA_FAILURE = 0x02,
00018        *        TRANSMISSION_WAS_PURGED = 0x03,
00019        *        PHYSICAL_ERROR_OCCURRED_ON_THE_INTERFACE_WITH_THE_WIFI_TRANSCEIVER = 0x04,
00020        *        INVALID_DESTINATION_ENDPOINT = 0x15,
00021        *        NO_BUFFERS = 0x18,
00022        *        NETWORK_ACK_FAILURE = 0x21,
00023        *        NOT_JOINED_TO_NETWORK = 0x22,
00024        *        SELF_ADDRESSED = 0x23,
00025        *        ADDRESS_NOT_FOUND = 0x24,
00026        *        ROUTE_NOT_FOUND = 0x25,
00027        *        BROADCAST_SOURCE_FAILED_TO_HEAR_A_NEIGBOR_RELAY_THE_MESSAGE = 0x26,
00028        *        INVALID_BINDING_TABLE_INDEX = 0x2B,
00029        *        INVALID_ENDPOINT = 0x2C,
00030        *        ATTEMPTED_BROADCAST_WITH_APS_TRANSMISSION = 0x2D,
00031        *        ATTEMPTED_UNICAST_WITH_APS_TRANSMISSION_BUT_EE_0 = 0x2E,
00032        *        SOFTWARE_ERROR_OCCURRED = 0x31,
00033        *        RESOURCE_ERROR_LACK_OF_FREE_BUFFERS_TIMERS_ETC = 0x32,
00034        *        DATA_PAYLOAD_TOO_LARGE = 0x74,
00035        *        INDIRECT_MESSAGE_UNREQUESTED = 0x75,
00036        *        ATTEMPT_TO_CREATE_A_CLIENT_SOCKET_FAILED = 0x76,
00037        *        KEY_NOT_AUTHORIZED = 0xBB,
00038        */
00039     virtual int getDeliveryStatus();
00040 
00041     int getDestinationAddress16();
00042 
00043     int getTransmitRetryCount();
00044 
00045     /**
00046     *   NO_DISCOVERY_OVERHEAD = 0x00,
00047     *    ADDRESS_DISCOVERY = 0x01,
00048     *    ROUTE_DISCOVERY = 0x02,
00049     *    ADDRESS_AND_ROUTE_DISCOVERY = 0x03,
00050     *    EXTENED_TIMEOUT_DISCOVERY = 0x40,
00051     */
00052     int getDiscoveryStatus();
00053     
00054     bool convert(APIFrame * frame);
00055 };
00056 
00057 #endif