NodeIdentificationIndicator.h

00001 #ifndef UK_AC_HERTS_SMARTLAB_XBEE_NodeIdentificationIndicator
00002 #define UK_AC_HERTS_SMARTLAB_XBEE_NodeIdentificationIndicator
00003 
00004 #include "Address.h"
00005 #include "RxBase.h"
00006 
00007 class NodeIdentificationIndicator : public RxBase
00008 {
00009 private:
00010     int offset;
00011 
00012 public:
00013     NodeIdentificationIndicator(APIFrame * frame);
00014 
00015     /**
00016     *
00017     * @returns
00018     * bit mask
00019     *       SUCCESS = 0x00,
00020     *       PACKET_ACKNOWLEDGED = 0x01,
00021     *       PACKET_WAS_A_BROADCAST = 0x02,
00022     *       PACKET_RECEIVED_ON_BOARDCAST_PAN = 0x04,
00023     *       PACKET_ENCRYPTED_WITH_APS_ENCRYPTION = 0x20,
00024     *       PACKET_WAS_SENT_FROM_AN_END_DEVICE = 0x40,
00025     *
00026     */
00027     int getReceiveStatus();
00028 
00029     Address getRemoteDevice();
00030 
00031     Address getSenderDevice();
00032 
00033     unsigned  char * getNIString();
00034 
00035     int getParentNetworkAddress();
00036 
00037     /*
00038     *
00039     * @returns
00040     *        COORDINATOR = 0x00,
00041     *        ROUTER = 0x01,
00042     *        END_DEVICE = 0x02,
00043     *
00044     */
00045     int getDeviceType();
00046 
00047     /*
00048     *
00049     * @returns
00050     *    FRAME_SENT_BY_NODE_IDENTIFICATION_PUSHBUTTON_EVENT = 0x01,
00051     *    FRAME_SENT_AFTER_JOINING_EVENT_OCCURRED = 0x02,
00052     *    FRAME_SENT_AFTER_POWER_CYCLE_EVENT_OCCURRED = 0x03,
00053     *
00054     */
00055     int getSourceEvent();
00056 
00057     int getDigiProfileID();
00058 
00059     int getManufacturerID();
00060     
00061     bool convert(APIFrame * frame);
00062 };
00063 
00064 #endif