You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > NGA State Notify 0x0163
SwitchKit Name
NGAStateNotify
Type
EXS and SwitchKit API message
Description
The M3UA object uses this message to notify the host about changes in object status.
Sent by
CSP
Related API Messages
NGA Configure (0x0130)
NGA Configure Query (0x0131)
NGA Service Configure (0x0160)
NGA Service Query (0x0161)
NGA State Query (0x0162)
SwitchKit Code
C Structure
typedef struct {
UBYTE AddrInfo[30];
UBYTE DataType;
UBYTE TLVCount;
UBYTE Data[221];
} XL_NGAStateNotify;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE reserved6[13];
UBYTE AddrInfo[30];
UBYTE DataType;
UBYTE TLVCount;
UBYTE Data[219];
} XL_NGAStateNotifyAck;
C++ Class
class XLC_NGAStateNotify : public XLC_OutboundMessage {
public:
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
void setAIBType(UBYTE x);
UBYTE getAIBType();
void setAECount(UBYTE x);
UBYTE getAECount();
void addAE(UBYTE AEpos, UBYTE AEtype, UBYTE AElen, UBYTE* AEvalue);
UBYTE* getAE(int AEpos);
void setAIBData(UBYTE* AIBDataPtr, UBYTE AIBDataLen);
UBYTE* getAIBData();
UBYTE getDataType() const;
void setDataType(UBYTE x);
UBYTE getTLVCount() const;
void setTLVCount(UBYTE x);
const UBYTE *getData() const;
UBYTE *getData();
void setData(UBYTE *x);
};
C++ Class Response
class XLC_NGAStateNotifyAck : public
XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
void setAIBType(UBYTE x);
UBYTE getAIBType();
void setAECount(UBYTE x);
UBYTE getAECount();
void addAE(UBYTE AEpos, UBYTE AEtype, UBYTE AElen, UBYTE* AEvalue);
UBYTE* getAE(int AEpos);
void setAIBData(UBYTE* AIBDataPtr, UBYTE AIBDataLen);
UBYTE* getAIBData();
; UBYTE getDataType() const;
void setDataType(UBYTE x);
UBYTE getTLVCount() const;
void setTLVCount(UBYTE x);
const UBYTE *getData();
UBYTE *getData();
void setData(UBYTE *x);
};
EXS API Hex Format
MESSAGE (White) |
RESPONSE (Gray) |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0x00NN) |
1, 2 |
Length (0x0007) |
3, 4 |
Message Type (0x0163) |
3, 4 |
Message Type (0x0163) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
Address Method 0x03 - Item |
8 |
Data Type 0x00 TLVs |
9 |
Number of TLVs to Follow |
||
: |
TLVs |
||
Number of AEs to Follow |
|||
AEs |
|||
: |
Checksum |
: |
Checksum |