OpenSCADAWiki: Home Page En/Doc/VC Aconcept/part4/part12 ...

3.8. The primitives of the widget

Any newly created widget is based on one of several primitives (finite element of the visualization) by installing of the related link as directly to the primitive, as well as through the several intermediate user widgets. Each of the primitives contains a mechanism (logic) of data model. A copy of the widget keeps the values of the properties of configuration of the the primitive specially for itself.

The purposes of the visualization interface includes support and work with the data model of the primitives of widgets. Primitives of the widget must be carefully developed and unitized in order to cover as many opportunities in the as possible to a smaller number of weakly connected with each other by their purpose primitives.

Table 4.11.a shows the list of primitives of widgets (basic elements of visualization).

Table 4.11.a. The library of the primitives of widgets (basic elements of visualization)

Each primitive, and the widget at all, contains the common set of properties/attributes in the composition which is shown in Table 4.11.b:

Table 4.11.b. The common set of properties/attributes in the widget

4.11.1. Elementary graphic figures (ElFigure)

Primitive is the basis for drawing basic graphic shapes with their possible combinations in a single object. Taking into account the wide range of various shapes, which must be maintained by the primitive, and at the same time the primitive must be simple enough for using and, if possible, for implementation, it was decided to limit the list of the basic figures used for the construction of the resulting graphics to these figures: line, arc, Bézier curve and fill of the enclosed spaces. Based at these basic figures, it is possible to construct derived figures by combining the basic. in the context of the primitive, there is possibility to set the transparency of the color in the range [0 .. 255], where '0'- complete transparency.

A list of additional properties/attributes of the primitive is given in Table 4.11.1.

Table 4.11.1. A list of additional properties/attributes of the primitive ElFigure

Id	Name	Number	Value
lineWdth	Line:width	20	Line width.
lineClr	Line:color	21	Line color.(Transparency of the color is defined as follows: red-127 | #ff0000-127, where "127" is the value of transparency.)
lineStyle	Line:style	22	Line style (solid, dashed, dotted).
bordWdth	Border:width	23	Line border width. The zero width indicates the lack of border.
bordClr	Border:color	24	Border color.
fillColor	Fill:color	25	Fill color.
fillImg	Fill:image	26	Fill image.
orient	Orientation angle	28	The rotation angle of the content of widget.
elLst	Element's list	27	List of graphic primitives in the following format: Line. Record form in the list: <line:p1 | (x | y):p2 | (x | y):[width | w{n}]:[color | c{n}]:[border_width | w{n}]:[border_color | c{n}]:[line_style | s{n}]> Arc. Record form in the list: <arc:p1 | (x | y):p2 | (x | y):p3 | (x | y):p4 | (x | y):p5 | (x | y):[width | w{n}]:[color | c{n}]:[border_width | w{n}]:[border_color | c{n}]:[line_style | s{n}]> Bézier curve. Record form in the list: <bezier:p1 | (x | y):p2 | (x | y):p3 | (x | y):p4 | (x | y):[width | w{n}]:[color | c{n}]:[border_width | w{n}]:[border_color | c{n}]:[line_style | s{n}]> Fill. Record form in the list: <fill:p1 | (x | y),p2 | (x | y),...,pn | (x | y):[fillClr | c{n}]:[fillImg | i{n}]>
The attributes for each point from the list of graphic figures elLst
p{n}x	Point {n}:x	30+n*6	Coordinates 'x' of the point {n}.
p{n}y	Point {n}:y	30+n*6+1	Coordinates 'y' of the point {n}.
w{n}	Width {n}	30+n*6+2	Width {n}.
ñ{n}	Color {n}	30+n*6+3	Color {n}.
i{n}	Image {n}	30+n*6+4	Image {n}.
s{n}	Style {n}	30+n*6+5	Style {n}.

4.11.2. Element of the form (FormEl)

Primitive is intended to provide the standard form elements to the user. The general list of attributes depends on the type of element. A list of additional properties/attributes of the primitive is given in Table 4.11.2.

Table 4.11.2. A set of additional properties/attributes of primitive FormEl

Id	Name	Number	Value
elType	Element type	20	Type of element (Line edit, Text edit, Check box, Button, Combo box, List, Slider, Scroll bar). On its value it is depended a list of additional attributes.
Line edit:
value	Value	21	The contents of the line.
view	View	22	Type of the editing line (Text; Combobox; Integer; Real Time, Date, Date and Time).
cfg	Config	23	Configuration of the line. The format of the value of the field for different types of lines: Text - the input template is indicated in the format of library QT. Combobox - contains a list of the values of the editable combobox. Integer - contains the configuration of input field of integer in the format: <Minimum>:<Maximum>:<Step of change>:<Prefix>:<Suffix>. Real - contains the configuration of input field of real in the format: <Minimum>:<Maximum>:<Step of change>:<Prefix>:<Suffix>:<The number of digits after the decimal point>. Time, Date, Date and time - to form the date following the the template with parameters: d - number of the day (1-31); dd - number of the day (01-31); ddd - acronym of the day ("Mon" ... "Sun"); dddd - the full name of the day ("Monday" ... "Sunday"); M - number of the month (1-12); MM - number of the month (01-12); MMM - acronym of the month ("Jan" ... "Dec"); MMMM - the full name of the month ("January" ... "December"); yy - last two digits of the year; yyyy - full year; h - hour (0-23); hh - hour (00-23); m - minutes (0-59); mm - minutes (00-59); s - seconds (0-59); ss - seconds (00-59); AP,ap - to display AM/PM or am/pm.
font	Font	25	Text font in the full record {<Family> <Size> <Bold> <Italic> <Underline> <Strikeout>}.
Text edit:
value	Value	21	The contents of the editor.
wordWrap	Word wrap	22	Automatic division of text by the words.
font	Font	25	Text font in the full record {<Family> <Size> <Bold> <Italic> <Underline> <Strikeout>}.
Check box:
name	Name	26	Bame/label of the checkbox.
value	Value	21	Value of the checkbox.
font	Font	25	Text font in the full record {<Family> <Size> <Bold> <Italic> <Underline> <Strikeout>}.
Button:
name	Name	26	Name, the inscription on the button.
value	Value	21	The value for the settled button.
img	Image	22	The image on the button.
color	Color	23	Color of the button.
colorText	Color:text	27	The color of the text.
checkable	Checkable	24	Sign of functioning as a settled button.
font	Font	25	Text font in the full record {<Family> <Size> <Bold> <Italic> <Underline> <Strikeout>}.
Combo box:
value	Value	21	Current value of the list.
items	Items	22	The entries of the list.
font	Font	25	Text font in the full record {<Family> <Size> <Bold> <Italic> <Underline> <Strikeout>}.
List:
value	Value	21	The selected list value.
items	Items	22	The entries of the list.
font	Font	25	Text font in the full record {<Family> <Size> <Bold> <Italic> <Underline> <Strikeout>}.
Slider and the scroll bar:
value	Value	21	Slider position.
cfg	Config	22	Configuratio of the slider in the format: <VertOrient>:<Min>:<Max>:<SinglStep>:<PageStep>. Where: VertOrient - sign of a vertical orientation, the default is the horizontal orientation; Min - minimum value Max - maximum value; SinglStep - the size of a single step; PageStep -the size of the page step.

4.11.3. Text element (Text)

This primitive is designed to display the plain text used as labels, and different signatures. With the aim of creating a simple frequent decorations the primitive must support the surrounding of the text by frame. A list of additional properties/attributes of the primitive is given in Table 4.11.3.

Table 4.11.3. The list of additional properties/attributes of the primitive Text

4.11.4. Element of visualization of media materials (Media)

This primitive is designed to play different media materials, ranging from simple images to the full audio and video streams. Taking into the account the variety of ways and libraries for playing a full audio and video streams as well as a serious laboriousness of implementing of all of these mechanisms in this widget, it was decided at the initial stage, only to realize the work with images and with simple animated images and video formats. A list of additional features/attributes of the primitive is given in Table 4.11.4.

Table 4.11.4. A set of additional properties/attributes of primitive Media

4.11.5. Element of constructing diagrams/trends (Diagram)

This primitive is designed to construct various diagrams, including graphs/trends showing ongoing process and archive data. At this time, the following types of diagrams are realized:

• "Graph" - allows you to build a one-dimensional graphs of the values of parameters of subsystems "Data acquisition" in time, as well as direct use of historical data to graph. It supports the tracing of current values and the values of the archive modes. It supports also the possibility of building the graphs of the parameters which have no archive of values.
• "Spectrum" - builds the frequency spectrum of values from the subsystem "Data acquisition". Window of the data of frequency spectrum is formed on the basis of the size of the widget horizontally, in pixels, and the available data of the parameters imposed on the horizontal grid size. In this regard, the minimum frequency is determined by the value of the attribute tSize (1/tSize), and maximum frequency of allocated frequencies is determined by half-width of the graph in pixels multiplied by the minimum frequency ( width/(2*tSize) ). It is supported the formation of the spectrum in the tracing mode.

The process of access to archive data is optimized, by means of an intermediate buffer for the display, as well as the package of traffic data in the query. A list of additional properties/attributes of the primitive is given in Table 4.11.5.

Table 4.11.5. A list of additional properties/attributes of the primitive Diagram

4.11.6. The element of building the protocols based on the archives of messages (Protocol)

This primitive is designed to visualize the data of the archive of messages through the formation of protocols with different ways of visualization, starting from a static scanning view and finishing with dynamic tracing of protocol of message. A list of additional properties/attributes of the primitive is given in Table 4.11.6.

Table 4.11.6. A list of additional properties/attributes of the primitive Protocol