Span Filter Query 0x00CE

SwitchKit Name

SpanFilterQuery

Type

EXS API and SwitchKit API message

Description

This message is used to query the values of the CGA detected and cleared validation timers

The "CGA Detected" validation timer determines how long a CGA alarm must be detected before the Excel platform informs the host with an Alarm message. The default is 2.5 seconds. The host will also receive a DS0 Status Change message of "Out Of Service" for the channels on the span.

The "CGA Cleared" validation timer is initiated after a CGA alarm has been detected and then clears. It determines how long the Excel platform must go without detecting a CGA alarm before informing the host with an Alarm Cleared message. The default is 12 seconds. The host will also receive a DS0 Status Change message of "In Service" for the channels on the span.

 

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

} XL_SpanFilterQuery;

C Structure Response

typedef struct {

unsigned short Status;

unsigned short NoCGAFilter;

unsigned short CGAFilter;

} XL_SpanFilterQueryAck;

C++ Class

class XLC_SpanFilterQuery : public XLC_OutboundMessage {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

};

C++ Class Response

class XLC_SpanFilterQueryAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

unsigned short getNoCGAFilter() const;

void setNoCGAFilter(unsigned short x);

unsigned short getCGAFilter() const;

void setCGAFilter(unsigned short x);

};

EXS API Hex Format

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0xNNNN)

1, 2

Length (0x000B)

3, 4

Message Type (0x00CE)

3, 4

Message Type (0x00CE)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

:

AIB

Address Method

0x00 - Individual AEs

8, 9

Status MSB, LSB

10, 11

No CGA Filter MSB, LSB

Number of AEs to follow

12, 13

CGA Filter MSB, LSB

AEs

0x0C Logical Span

14

Checksum

:

Checksum