You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > NGA Service Query 0x0161
SwitchKit Name
NGAServiceQuery
Type
EXS and SwitchKit API message
Description
Queries the objects for their service state. The service state is the state that the user put the object into. For example, if the user put a link in service but the link is not physically connected, the service state is
In Service
Sent by
Host application
Related API Messages
NGA Configure (0x0130)
NGA Service Configure (0x0160)
NGA Configure Query (0x0131)
NGA State Query (0x0162)
NGA State Notify (0x0163)
SwitchKit Code
C Structure
typedef struct {
UBYTE AddrInfo[30];
UBYTE DataType;
UBYTE TLVCount;
UBYTE Data[221];
} XL_NGAServiceQuery;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE reserved6[13];
UBYTE AddrInfo[30];
UBYTE DataType;
UBYTE TLVCount;
UBYTE Data[219];
} XL_NGAServiceQueryAck;
C++ Class
class XLC_NGAServiceQuery : 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_NGAServiceQueryAck : 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 (0x0161) |
3, 4 |
Message Type (0x0161) |
5, 6 |
Sequence Number |
5, 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 |
||
10, 11 |
TLVs |
||
Number of AEs to Follow |
: |
Checksum |
|
AEs |
|||
: |
Checksum |