AlmList

Description: This statement displays one of the four alarm lists on the screen in a specified format.

Returns: Nothing

Usage: Steady State

Format: AlmList(List, DateForm, TimeForm, MessageForm, X, Y, Width, Start, N, Height, LowLevel, HighLevel, LowCategory, HighCategory)

Parameters: List { numeric } { required } { no default: }

Any numeric expression giving the list number to search for the alarm. The valid list numbers are:

List	Meaning
0	Logged alarm list
1	Active alarm list
2	Unacknowledged alarm list
3	Current alarm list

You may add any of the following numbers to the specified list number to filter the selected list.

List	Attributes
4	Use combined alarm list
8	Don't include alarm occurrences in list
16	Don't include alarm clears in list
32	Don't include alarm acknowledges in list
64	Don't include alarm enables in list
128	Don't include alarm disables in list

DateForm { numeric } { required } { no default: }

Any numeric expression giving the option for the date format. The formats are given in the appendix: VTS Date Formats.

Any value not represented in the list is Invalid.

TimeForm { numeric } { required } { no default: }

Any numeric expression giving the option for the time format..

The formats are given in the appendix: VTS Time Formats.

Any value not indicated in the list is Invalid.

MessageForm { numeric } { required } { no default: }

The format of the alarm message displayed. The options are chosen by adding together all of the option numbers that are required.

MessageForm	Bit No.	Message Format
1	0	Display time first (otherwise date is first)
2	1	Display level descriptor
4	2	Display event descriptor
8	3	Display category name (descriptor)
16	4	Display message 1
32	5	Display message 2 always
64	6	Display message 2 only if value is included
128	7	Inhibit second date/time for combined list
256	8	Place combined list cleared date/time first

The event descriptors (bit 2) are Alarm, Normal, Enable, Disable, and Ack.

X { numeric } { required } { no default: }

Any numeric expression giving the X screen coordinate of the left side of the alarm message area.

Y { numeric } { required } { no default: }

Any numeric expression giving the Y screen coordinate of the top of the alarm message area.

Width { numeric } { required } { no default: }

Any numeric expression giving the width of the alarm message area in units of X screen coordinates.

Start { numeric } { required } { no default: }

Any numeric expression giving the list entry that is to be the first to be displayed. This number counts only those list entries that fall within the limits for level and category specified by the last four parameters.

N { numeric } { required } { no default: }

Any numeric expression giving the number of lines of alarm messages to display; the first alarm starts at 1.

Height { numeric } { required } { no default: }

Any numeric expression giving the height to be allowed for each line in the list. The messages will not overlap, even if the height is specified to be less than the height of the text. If the height is specified less than 0, the list runs in reverse order. If the height is specified greater than 16 pixels, the text height is increased to the largest multiple of eight pixels that will fit within that line height with at least one blank space between lines. The text width will always be eight pixels regardless of the height.

LowLevel { numeric } { required } { no default: }

Any numeric expression giving the lower limit for the alarm priority level. If the alarm level is strictly below this value, the alarm is not included in the count specified by the N parameter.

HighLevel { numeric } { required } { no default: }

Any numeric expression giving the upper limit for the alarm priority level. If the alarm level is strictly above this value, the alarm is not included in the count specified by the N parameter.

LowCategory { numeric } { required } { no default: }

Any numeric expression giving the lower limit for the alarm category. If the alarm category is strictly below this value, the alarm is not included in the count specified by the N parameter.

HighCategory { numeric } { required } { no default: }

Any numeric expression giving the upper limit for the alarm category. If the alarm category is strictly above this value, the alarm is not included in the count specified by the N parameter.

Comments: The alarm messages are displayed with one message per line, and with the oldest message at the top of the list. Alarm lists are always maintained in chronological order. The messages appear with the different elements in the same order as the parameters described above. More than one list may appear on the screen at any one time. AlmList is always a destructive graphics statement.

Example:

AlmList(35 { Show current alarms without acknowledges },

20 { Date format is Mmm d },

4 { Time format hh:mm:ss.dd },

66 { Whole message + priority level },

10, 10 { Start in upper left corner of screen },

1800 { Width in screen coordinates },

Max(NumAlarm(35, 0, 15, 0, 0) - 9, 1){ Display 10 most recent alarms - priority, category limits should match AlmList },

10 { Display 10 lines of alarm messages },

50 { Text height in screen coordinates },

0, 15 { Priority limits },

0, 0 { Category limited to 0 only });

In the example displayed above, AlmList displays the 10 most recent alarms of any priority in category 0 on a large area of the screen.