You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > NGA State Query 0x0162

NGA State Query 0x0162

SwitchKit Name

NGAStateQuery

Type

EXS and SwitchKit API message

Description

NGA State Query 0x0162

Queries the M3UA objects for their actual state status. Do not confuse with the Service State Query. The following example shows the difference. If the user puts a link in service but the link is not physically connected, the service state is In Service but the state status is
Out of Service.

Sent by

Host application

Related API Messages

NGA Configure (0x0130)
NGA Service Configure (0x0160)
NGA Configure Query (0x0131)
NGA Service Query (0x0161)
NGA State Notify (0x0163)

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_NGAStateQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[219];

} XL_NGAStateQueryAck;

C++ Class

class XLC_NGAStateQuery : 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_NGAStateQueryAck : 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 (0x0162) | 3, 4 | Message Type (0x0162)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method 0x03 - Item | 8 | Data Type 0x00 TLVs
9 | Number of TLVs to Follow
10, 11 | TLVs 0xE002 Service State
Number of AEs to Follow | : | Checksum
AEs 0x67 Functional Area 0x08 SS7 Stack 0x64 Global Object Type
: | Checksum

The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
See Address Information Block.