Output Linear Bar Graph object

This object is a linear bar graph or thermometer. Linear bar graphs are defined by an enclosing rectangle in any one of four orientations. A target value can be optionally marked on the bar graph. The position attribute of the bar graph (in the parent object) always refers to the upper left corner of the enclosing rectangle regardless of orientation.

--```,`,`,,``,,````,,,,,``,`,,-`-`,,`,,`,`,,`---

1 value 2 target value 3 minimum value 4 maximum value

Figure B.11 — Output Linear Bar Graph — examples

This object is drawn transparent so that objects can be placed underneath to enhance the appearance. See Figure B.11 — Output Linear Bar Graph — examples and Table B.36 — Output Linear Bar Graph events and Table B.37 — Output Linear Bar Graph attributes and record format.

Allowed Commands:

⎯ Change Numeric Value command;

Provided by IHS under license with ISO Licensee=University of Alberta/5966844001, User=ahmadi, rozita

--```,`,`,,``,,````,,,,,``,`,,-`-`,,`,,`,`,,`---

⎯ Change Attribute command;

⎯ Change Size command;

⎯ Get Attribute Value message (VT version 4 and later).

Table B.36 — Output Linear Bar Graph events

Event Caused by VT behaviour Message

On Refresh See Data Mask Refresh for caused by conditions

Redraw this object.

— On Change

Value

Change Numeric Value command

Redraw this object, refresh parent mask. Change Numeric Value response On Change

Attribute

Change Attribute command

Redraw this object, refresh parent mask. Change Attribute response On Change Size Change Size

command

Draw object at current location in background colour to erase it. Refresh parent mask.

Change Size response

Table B.37 — Output Linear Bar Graph attributes and record format Attribute Name AID Type Size

(bytes)

Range or Value

Record

byte Description

Object ID Integer 2 0-65534 1-2 Object identifier. Shall be unique within the object pool.

Type [0] Integer 1 =18 3 Object Type = Output Output Linear Bar Graph object

Width 1 Integer 2 0-65535 4 - 5 Maximum width of the enclosing rectangle in pixels. Bar graph cannot exceed the bounds of this imaginary rectangle.

Height 2 Integer 2 0-65535 6-7 Maximum height of the enclosing rectangle in pixels. Bar graph cannot exceed the bounds of this imaginary rectangle.

Colour 3 Integer 1 0-255 8 Bar graph fill and border colour.

Target line colour

4 Integer 1 0-255 9 Target line colour (if drawn).

Options 5 Bitmask 1 0-63 10 Logical bits to indicate which parts to draw:

1 = TRUE

Bit 0 = Draw border Bit 1 = Draw target line Bit 2 = Draw ticks

Bit 3 = Bar graph type. If this bit is FALSE (0), bar graph is filled. If this bit is TRUE (1), Bar graph is not filled but rather shows the current value as a single line at the proper position within the bar graph.

Orientation and direction of the bar graph:

Bit 4 = Axis orientation. 0 = vertical (increasing values move parallel to the Y axis with constant X), 1 = horizontal (increasing values move parallel to the X axis with constant Y)

--```,`,`,,``,,````,,,,,``,`,,-`-`,,`,,`,`,,`---

(bytes)

Range or Value

Record

byte Description

Bit 5 = Direction. 0 = Grows negative (left or down). 1 = Grows positive (right or up).

Number of ticks 6 Integer 1 0-255 11 Number of ticks to draw along bar graph. If one tick, it is drawn in the middle of the bar graph.

For two or more ticks a tick is placed at each end of the bar graph and the rest are evenly spaced between them.

Min value 7 Integer 2 0-65535 12-13 Minimum value.

Max value 8 Integer 2 0-65535 14-15 Maximum value.

Variable reference

9 Integer 2 0-65534, 65535

16-17 Object ID of a Number Variable object in which to retrieve the bar graph’s value. If this attribute is set to NULL, the value is retrieved directly from the value attribute instead.

The referenced Number Variable’s value shall be in the range 0-65535.

Value [12] Integer 2 0-65535 18-19 Current value. Used only if variable reference is NULL. Bar graph fills or moves, depending on bar graph type, to a point calculated from this value and min/max values. If value > Max value or value < Min value, the bar graph is filled or shown empty and no error is generated by the VT.

Target value variable reference

10 Integer 2 0-65534, 65535

20-21 Object ID of a Number Variable object in which to retrieve the bar graph’s target value. If this attribute is set to NULL, the target value is retrieved directly from the Target value attribute instead.

The referenced Number Variable’s value shall be in the range 0-65535.

Target value 11 Integer 2 0-65535 22-23 Current target value. Used only if Target value variable Reference attribute is NULL. Target value is displayed as a line on the bar graph to indicate some target or warning level. If Target value > Max value or Target value < Min value, the target line is shown on one of the ends of the bar graph and no error is generated by the VT.

Number of macros to follow

Integer 1 0-255 24 Number of Macro references included even if zero. Each Macro reference consists of 2 bytes:

one for event ID and one for Macro ID.

Whenever the indicated event occurs, the associated Macro is executed.

VT version 5 and later: A reference to a Macro with 16-bit Object ID shall count as 2 macro references within the context of this attribute.

Repeat:

{Event ID}

Integer 1 0-255 25… (List these after all objects have been listed.) 8-bit Macro Object ID reference: Event ID of event type that causes this Macro to execute.

16-bit Macro Object ID reference (only for VT version 5 and later): Event ID of event type that causes this Macro to execute or 0xFF (see Clause 4.6.22.3)

Provided by IHS under license with ISO Licensee=University of Alberta/5966844001, User=ahmadi, rozita

--```,`,`,,``,,````,,,,,``,`,,-`-`,,`,,`,`,,`---

Attribute Name AID Type Size (bytes)

Range or Value

Record

byte Description

{Macro ID} Integer 1 0-255 26… 8-bit Macro Object ID reference: Macro ID of the Macro to execute.

16-bit Macro Object ID reference (only for VT version 5 and later): Low byte or high byte of Macro ID of the Macro to execute (see Clause 4.6.22.3)

Output Arched Bar Graph object