GSEOS Data Display Language Description

Transcription

1 Technische Universität Braunschweig Data Display Language Description Revision 1.5 IDA July 2003 Prepared by Hagen Schmidt

2 Data Display Ref.: IDA Page: 2 of: 32 Tables and Figures Scope Purpose of this Document Change Record Reference Documentation Abbreviations Introduction Data Display Configuration Language General Syntax General Properties Set the Data Display Background Color Set the Data Display Background Picture Set the Background Style Items Item Types Static Text Static Pictures Group Boxes Command Buttons Scalar Numeric Items Numeric Field Items Text Reference Items String Items Image Items Bargraphs Plot Items Item Properties Arrangement AutoRange AutoX AutoY BorderStyle Caption ColorN Expression Font FormatString FuncX FuncY History IsLogarithmic NumFormatX / NumFormatY Picture RangeX RangeY Rectangle ScaleX ScaleY Scroll... 31

3 Data Display Ref.: IDA Page: 3 of: ShowGrid ShowScale SeparatorString TextAlign UnderLength UsePicture Zoom... 32

4 Data Display Ref.: IDA Page: 4 of: 32 Tables and Figures Table 1 Change Record... 5 Table 2 Abbreviations... 5 Table 3 Key Word Quick Reference... 8 Figure 1 Example of a Static Text Figure 2 Example of a Static Picture Figure 3 Example of a Group Box Figure 4 Example of a Command Button Figure 5 Example of a Single Numeric QLook Item Figure 6 Example of an Array Item Figure 7 Example of a Text Reference Figure 8 Example of a String Item Figure 9 Example of an Image Item Figure 10 Example of a bargraph Figure 11 Example of a plot y (x)... 24

5 Data Display Ref.: IDA Page: 5 of: 32 1 Scope 1.1 Purpose of this Document Purpose of this document is to describe the language of the Data Display configuration files to enable the configuration of Data Displays by editing the files as text. 1.2 Change Record Table 1 Change Record Date Revision Author Affected Sections 6/7/ Schmidt all sections 7/10/ Schmidt 3 10/11/ Schmidt 3 11/18/ Schmidt all sections 1/25/ Schmidt 3 7/25/ Schmidt Reference Documentation All related documents are listed in the Document Index IDA Abbreviations Table 2 Abbreviations Ground Support Equipment Operating System

6 Data Display Ref.: IDA Page: 6 of: 32 2 Introduction The configuration of all QLook Items will be stored in the Data Display configuration files (with the extension.scn ). This file contains simple ASCII text. All statements are single line-oriented. It should be used one statement per single line at maximum (empty lines are ignored). The configuration file starts with the general properties as background color and - picture. Thereafter all QLook Items will be specified as item blocks. A simple configuration file is shown as below: // // // Counter.scn // // Color = {0x00FF00FF}; Picture = "\picture.bmp"; UsePicture = {1}; TextRef { Rectangle = {30, 11, 152, 60}; Font = {"Comic Sans MS", 128, 700, 0}; TextAlign = {2}; Color0 = {00FF0000, 00FFFFFF}; Color1 = { , 00FFFF00}; Color2 = {00FFFFFF, FF}; Color3 = { , 0000FFFF}; Color4 = {004080FF, 0000FF00}; Expression = "Count (_SelfStimulationTicker.ul & 0xf)"; FormatString = "%d"; Arrangement = {1, 1}; Zoom = {1, 1}; Scroll = {0, 0}; BorderStyle = {0}; } NOTE: The format and syntax of the Data Display configuration files are internal - changes of it can not be excluded afterwards.

7 Data Display Ref.: IDA Page: 7 of: 32 3 Data Display Configuration Language 3.1 General Syntax The Data Display configuration files consist of line oriented ASCII text. It starts with the general properties to specify the Data Display background. Thereafter all single QLook Items will be specified as item blocks. The general structure of all property statements is: keyword = "property string"; to set string values or keyword = {property value list}; to set single numeric values or value lists Items are specified in blocks. The general structure of item blocks is: keyword the item key word { block start property statement 1; first property statement property statement 2; next property statement property statement n; last property statement } block end In Table 3 Key Word Quick Reference all valid key words are listed.

8 Data Display Ref.: IDA Page: 8 of: 32 Table 3 Key Word Quick Reference Key Word Description { start of block } end of block [ start of sub block (multi plots) ] end of sub block (multi plots) // comment Arrangement Array AutoRange AutoX AutoY BarGraph BorderStyle Button Caption Color Color0 Color1 Color2 Color3 Color4 Expression FixPic FixText Font FormatString GroupBox arrangement of arrays.(number of rows and columns) vector data item, (data array) flag to enable auto arrangement of arrays flag to enable auto scaling of the x-axis flag to enable auto scaling of the y-axis graphical item to display arrays as bars style of the border of group boxes button to send commands caption of an item color of Data Display background colorset " 2" (fore- and background color) colorset " 1" (fore- and background color) default colorset (fore- and background color) colorset "1" (fore- and background color) colorset "2" (fore- and background color) item expression in Language static picture item static text item font style of an item format string to define the numeric output in data items (like printf in C) group box item

9 Data Display Ref.: IDA Page: 9 of: 32 Key Word History Image IsLogarithmic Item ItemInfo ListView NumFormatX NumFormatY Picture Plot RangeX RangeY Rectangle ScaleX ScaleY Scroll SeparatorString ShowGrid ShowScale String TextAlign TextRef UnderLength UsePicture Zoom Description history depth of y (n) / y(x) data items (plots) vector data item as picture (bitmap) flag to enable logarithmic scaling of the x- and y-axis scalar data item bubble help text list view data item Format string for x-axis labeling Format string for y-axis labeling used picture file of the Data Display or a static picture item y (n) or y (x) data item (plot) minimum and maximum of the x-axis minimum and maximum of the y-axis item rectangle in logical coordinates (left, top, width and height) minor and major unit of the x-axis minor and major unit of the y-axis scrolling position (image) definition of a character sequence between the columns in arrays flag to enable a horizontal/vertical grid on bargraphs / plots flag to enable x- and y-axis string item text alignment of items (left or right aligned or centered) text reference item flag to display array items with under length or not flag if the background of the data display or the item is to fill with the picture or solid color zoom factors of the image data item (numerator and denominator)

10 Data Display Ref.: IDA Page: 10 of: General Properties To specify the background there are three key words: Color, Picture, UsePicture. The general properties are usually found at start of the Data Display configuration file, but they can be placed to any location outside the item blocks Set the Data Display Background Color Any color of the 24 bit RGB color space can be use to specify the background color. The background color will be specified as long integer RGB value in hexadecimal format: Color = {0x00FF00FF}; Set the Data Display Background Picture All pictures in the common Microsoft Windows Bitmap format (extension.bmp ) can be chosen to tile the background. The file path is either relative to the screen directory path - the file path must be start with \ - or full defined: Picture = "\picture.bmp"; or Picture = "C:\BackGrounds\picture.bmp"; Set the Background Style The kind of background will be choose with the statement: UsePicture = {n};" n = "1": tile the background with the picture n = "0": set background as solid color

11 Data Display Ref.: IDA Page: 11 of: Items All QLook Items stored in the configuration files are specified in blocks. The item block starts with the item specifier. In the next line the block will be opened with the key word {. After all property lines the block will be finished with the key word } : keyword the item key word { block start property statement 1; first property statement property statement 2; next property statement property statement n; last property statement } block end The property keywords of all QLook Items are identical, but they may not have an effect at all.

12 Data Display Ref.: IDA Page: 12 of: Item Types Static Text Key Word Description FixText Display static text on screen in any font and font size, multiple lines are possible. Used Properties Rectangle Caption Font TextAlign Color2 item rectangle text to display text font text alignment fore- and background color Example FixText { Rectangle = {0, 0, 134, 45}; Caption = "FixText\ntext is fixed! Font = {"Comic Sans MS", 48, 400, 0}; TextAlign = {2}; Color2 = { , 00FFFFFF}; } Figure 1 Example of a Static Text

13 Data Display Ref.: IDA Page: 13 of: Static Pictures Key Word Description FixPic Display static picture on screen using a Windows Bitmap file. Used Properties Rectangle Picture item rectangle file path of the bitmap file to show (*.bmp) Example FixText { Rectangle = {0, 0, 100, 40}; Picture = "\picture.bmp } Figure 2 Example of a Static Picture

14 Data Display Ref.: IDA Page: 14 of: Group Boxes Key Word Description GroupBox Display a background rectangle below all items to group it. Used Properties Rectangle Caption Font TextAlign Color2 BorderStyle item rectangle caption of the box caption text font caption text alignment fore- and background color style of the border around the box Example GroupBox { Rectangle = {0, 0, 104, 38}; Caption = "Group Box"; Font = {"Arial", 10, 600, 0}; TextAlign = {0}; Color2 = { , 00C0C0C0}; BorderStyle = {1}; } Figure 3 Example of a Group Box

15 Data Display Ref.: IDA Page: 15 of: Command Buttons Key Word Description Button button to send any commands Used Properties Rectangle Caption Font Color2 button rectangle button caption caption text font fore- and background color Expression commnd expression to send after actuation Example Button { Rectangle = {0, 0, 20, 6}; Caption = "Beep"; Font = {"Arial", 10, 700, 0}; Color2 = { , 00C0C0C0}; Expression = "_Beep ();"; } Figure 4 Example of a Command Button

16 Data Display Ref.: IDA Page: 16 of: Scalar Numeric Items Key Word Description Used Properties Item single numeric QLook Item Rectangle Font TextAlign Color2 item rectangle item font alignment of the item fore- and background color Example Expression FormatString Language expression of the item Item { Rectangle = {0, 0, 70, 7}; Font = {"Courier New", 18, 400, 0}; TextAlign = {0}; Color2 = { , 00FFFFFF}; Expression = _SelfStimulationTicker.ul"; FormatString = "%d 0x%08X"; } format string to define the data output (like printf format string in C) Figure 5 Example of a Single Numeric QLook Item

17 Data Display Ref.: IDA Page: 17 of: Numeric Field Items Key Word Description Used Properties Array QLook Item as numeric array Rectangle Font UnderLength Color2 Expression FormatString SeparatorString Arrangement AutoRange item rectangle item font shorter or full font height fore- and background color Language expression of the item format string to define the data output (like printf format string in C) charaters between the single columns number of columns and rows of the array enble/disable automatic arrangment Example Array { Rectangle = {0, 0, 166, 6}; Font = {"Courier New", 9, 400, 0}; UnderLength = {0}; Color2 = { , 00FFFFFF}; Expression = _BTIF.bmp FormatString = "%08X"; SeparatorString = " "; Arrangement = {8, 2}; AutoRange = {0}; } NOTE: The used font in arrays must have a fixed size of all characters. Figure 6 Example of an Array Item

18 Data Display Ref.: IDA Page: 18 of: Text Reference Items Key Word Description TextRef QLook Item as text reference Used Properties Rectangle Font TextAlign item rectangle item font alignment of the item Color0 fore- and background color level -2 Color1 fore- and background color level -1 Color2 default fore- and background color (level 0) Color3 fore- and background color level +1 Color4 fore- and background color level +2 Example Expression FormatString Language expression of the item format string to define the data output (like printf format string in C) TextRef { Rectangle = {0, 0, 27, 8}; Font = {"Courier New", 20, 900, 0}; TextAlign = {0}; Color0 = {00FFFFFF, FF}; Color1 = { , 0000FFFF}; Color2 = { , 00FFFFFF}; Color3 = { , 0000FFFF}; Color4 = {00FFFFFF, FF}; Expression = Count (_SelfStimulationTicker.ul % 10)"; FormatString = "%d"; } Figure 7 Example of a Text Reference

19 Data Display Ref.: IDA Page: 19 of: String Items Key Word Description Used Properties String QLook Item as text string Rectangle Font TextAlign Color2 Expression item rectangle item font alignment of the item fore- and background color Language expression of the item Example String { Rectangle = {0, 0, 91, 8}; Font = {"Arial", 20, 900, 0}; TextAlign = {2}; Color2 = { , 00FFFFFF}; Expression = "This is a string item!"; } Figure 8 Example of a String Item

20 Data Display Ref.: IDA Page: 20 of: Image Items Key Word Description Used Properties Image QLook Item as bitmap Rectangle Color2 Expression Zoom Scroll item rectangle fore- and background color Language expression of the item predefined zoom factors (numerator and denominator) scrolling position of the displayed image Example Image { Rectangle = {0, 0, 41, 6}; Color2 = { , 00FFFFFF}; Expression = "_BTIF.bmp"; Zoom = {1, 1}; Scroll = {10, 3}; } Figure 9 Example of an Image Item

21 Data Display Ref.: IDA Page: 21 of: Bargraphs Key Word Description BarGraph graphical QLook Item as bar graph Used Properties Rectangle Font Color2 Color3 Expression ShowScale ShowGrid IsLogarithmic RangeY ScaleX ScaleY AutoX AutoY item rectangle item font fore- and background color of the bars fore- and background color of the axises Language expression of the item enable x-/y-axis enable horizontal/vertical grid is x-/y-axis logarithmic value range of displayed y-axis minor/major unit of the x-scale minor/major unit of the y-scale auto scaling of the x-axis auto scaling of the y-axis Example BarGraph { Rectangle = {4, 46, 322, 40}; Font = {"Times New Roman", 9, 400, 0}; Color2 = { , 00FFFFFF}; Color3 = {00A00000, 00FF8080}; Expression = "History.db[0, 200]"; ShowScale = {0, 1}; ShowGrid = {1, 1}; IsLogarithmic = {0, 0}; RangeX = {0, 0}; ScaleX = {5, 25}; RangeY = {-0.5, 0.5}; ScaleY = {0.25, 0.5}; AutoY = {0, 0, 0, 0}; }

22 Data Display Ref.: IDA Page: 22 of: 32 Figure 10 Example of a bargraph

23 Data Display Ref.: IDA Page: 23 of: Plot Items Key Word Description Plot graphical QLook Item as plot (y (n) / y (x)) Used Properties Rectangle Font [n] FuncX FuncY ShowScale ShowGrid IsLogarithmic NumFormatX RangeX ScaleX AutoX NumFormatY RangeY ScaleY AutoY History Color2 Color3 item rectangle item font start of plot # n expression for x-coordinate expression for y-coordinate enable x-/y-axis enable horizontal/vertical grid is x-/y-axis logarithmic format string for x-axis labeling value range of displayed x-axis minor/major unit of the x-scale auto scaling of the x-axis format string for y-axis labeling value range of displayed y-axis minor/major unit of the y-scale auto scaling of the y-axis number of points in the plot (history depth) fore- and background color of the plot fore- and background color of the axises

24 Data Display Ref.: IDA Page: 24 of: 32 Example Plot { Rectangle = {5, 109, 326, 59}; Font = {"Courier New", 9, 400, 0}; [0] { FuncX = {"sin (_SelfStimulationTicker.ul* )", 0, 0}; FuncY = {"sin (_SelfStimulationTicker.ul* )", 0, 1}; ShowScale = {1, 1}; ShowGrid = {1, 1}; IsLogarithmic = {0, 0}; NumFormatX = "%g"; RangeX = {1338.8, 1350}; ScaleX = {0.4, 2}; AutoX = {1, 1, 1, 1}; NumFormatY = "%g"; RangeY = {-0.999, }; ScaleY = {0.003, 0.015}; AutoY = {1, 1, 1, 1}; History = {40}; Color2 = {000000FF, 00FFFFFF}; Color3 = { , 00C0C0C0}; } } Figure 11 Example of a plot y (x)

25 Data Display Ref.: IDA Page: 25 of: Item Properties All items use equal property key words to specify its properties. In the sections below the usage of all property key words are described Arrangement To specify the number of columns and rows of array items the key word Arrangement is used: Arrangement = {columns, rows}; AutoRange If the user enables this flag, the array will arrange automatically in its respective size. The number of columns or rows correlates to the size of the return value of the G-language expression. AutoRAnge = {flag}; AutoX The scaling of the x-axis can be set as automatic or as user defined: AutoX = {IsMinAuto, IsMaxAuto, IsMajUnitAuto, IsMinUnitAuto}; IsMinAuto: 1: automatic scaling of the minimum 0: user defined scaling of the minimum IsMaxAuto: 1: automatic scaling of the maximum 0: user defined scaling of the maximum IsMajUnitAuto: 1: automatic scaling of the major unit 0: user defined scaling of the major unit IsMinUnitAuto: 1: automatic scaling of the minor unit 0: user defined scaling of the minor unit

26 Data Display Ref.: IDA Page: 26 of: AutoY The scaling of the y-axis can be set as automatic or as user defined: AutoY = {IsMinAuto, IsMaxAuto, IsMajUnitAuto, IsMinUnitAuto}; IsMinAuto: 1: automatic scaling of the minimum 0: user defined scaling of the minimum IsMaxAuto: 1: automatic scaling of the maximum 0: user defined scaling of the maximum IsMajUnitAuto: 1: automatic scaling of the major unit 0: user defined scaling of the major unit IsMinUnitAuto: 1: automatic scaling of the minor unit 0: user defined scaling of the minor unit BorderStyle There are three styles of group boxes: group boxes without border: style = 0 group boxes with a border in 3D-style: style = 1 group boxes with an outer border: style = 2 To set the style use the statement: BorderStyle = {style}; Caption Some items like GroupBox, FixText or Button use a caption. To specify the caption text use the statement: Caption = "Caption Text";

27 Data Display Ref.: IDA Page: 27 of: ColorN All items own a fore- and a background color. The default color is Color2. All items except text references use this statement only. In text references the used color index is depend on the item value: Color0 = {Foreground, Background}; Level "-2" Color1 = {Foreground, Background}; Level "-1" Color2 = {Foreground, Background}; Level "0" (default) Color3 = {Foreground, Background}; Level "+1" Color4 = {Foreground, Background}; Level "+2" The correlation of value and color index is defined in the Language source file in the declaration of the used text reference Expression To define a data item any valid expression in Language can be used. This allows most possible flexibility of data handling. The expression is stored as text string: Expression = "Data Expression"; Font It is possible to use any font in all items. You should use a fixed font in data arrays only: Font = {"FontFace", Size, Weight, IsItalic}; FontFace: the font to use Size: Weight: IsItalic: the font size in points the font weight 1: italic style 0: regular style

28 Data Display Ref.: IDA Page: 28 of: FormatString The format string define the data output like printf in C. It is stored as text string: FormatString = "Format"; Any combination of following format identifiers is supported: %d signed decimal output (radix = 10) %u unsigned decimal output (radix = 10) %x or %X hexadecimal output (radix = 16) %b binary output (radix = 2) %c output as character %f output as floating point value (floating point notation always) %e output as floating point value (scientific notation always) %g output as floating point value (best notation for the current value) (Strings as %s and pointers as %p are not supported.) FuncX Definition of the x-value for a plot. Any valid expression in Language can be used. This allows most possible flexibility of data handling. The expression is stored as text string: FuncX = {"X Data Expression", FunctionType, IsTriggeredOnThis}; FunctionType: 1: x-coordinate is n (y (n)) 0: x-axis is a function (y (x)) IsTriggeredOnThis: 1: plot will be triggered by this expression 0: plot will not be triggered by this expression

29 Data Display Ref.: IDA Page: 29 of: FuncY Definition of the y-value for a plot. Any valid expression in Language can be used. This allows most possible flexibility of data handling. The expression is stored as text string: FuncY = {"Y Data Expression", FunctionType, IsTriggeredOnThis}; FunctionType: IsTriggeredOnThis: 0: y-coordinate is a function 1: plot will be triggered by this expression 0: plot will not be triggered by this expression History Define the number of displayed tuple of a plot item. If the plot is defined as f = y (n), the history is the width of the x-axis [0..History] IsLogarithmic The scaling of the axis can be set as linear (default) or as logarithmic: IsLogarithmic = {IsXAxisLogarithmic, IsYAxisLogarithmic} IsXAxisLogarithmic: 1: x-axis is logarithmic scaled 0: x-axis is linear scaled IsYAxisLogarithmic: 1: y-axis is logarithmic scaled 0: y-axis is linear scaled NumFormatX / NumFormatY The labeling of both axes is defined as format strings like printf in C. It is stored as text string: NumFormatX = "Format"; NumFormatY = "Format";

30 Data Display Ref.: IDA Page: 30 of: Picture Define the file path of the picture to show in static picture items. The picture file must be stored in any Microsoft Windows Bitmap file format (file extension.bmp ): Picture = "PictureFilePath"; RangeX The range of the x-axis is stored with the statement: RangeX = {Minimum, Maximum}; RangeY The range of the y-axis is stored with the statement: RangeY = {Minimum, Maximum}; Rectangle The position and size of any item is stored with the statement: Rectangle = {Top, Left, Width, Height}; You should note that most items are calculating its size at runtime so that any changes of Width and Height may not have any affect ScaleX The scaling of the x-axis units is stored with the statement: ScaleX = {MajorUnit, MinorUnit}; ScaleY The scaling of the y-axis units is stored with the statement: ScaleY = {MajorUnit, MinorUnit};

31 Data Display Ref.: IDA Page: 31 of: Scroll If the size of a displayed image exceeds the item, scroll bars are viewed. The position of the scroll bars is stored with the statement: Scroll = {horizontal_position, vertical_position}; ShowGrid A grid over a bargraph or plot can be enabled with the statement: ShowGrid = {ShowXGrid, ShowYGrid}; The grid is built of vertical lines out the x-axis and horzontal lines out the y-axis at the major units ShowScale Both axis can be enabled or disabled: ShowScale = {ShowXAxis, ShowYAxis}; SeparatorString You can define a sequence of characters to separate the single columns in array items (mostly are used spaces): SeparatorString = "Separator"; TextAlign The text or viewed data values of the most items can be aligned to the left or right border or may be centered: TextAlign = {Alignment}; Alignment 0: left aligned 1: right aligned 2: centered

32 Data Display Ref.: IDA Page: 32 of: UnderLength Array items may are displayed with under length (the whole font height) or with shorter height (numeric only): UnderLength = {ShowUnderLength}; ShowUnderLength 0: Show array rows with shorter font height 1: Show array rows with full font height UsePicture The background of the data display as some items can be filled with a texture or plain color: UsePicture = {IsBitmap}; IsBitmap 0: Fill with plain color 1: Fill with a texture (bitmap) Zoom To predefine a zoom factor used by image items you may use the statement: Zoom = {Numerator, Denominator}; The zoom factor will be calculated by: Zoom = Numerator Denominator