1.16.2.1.19 Switch element

The Switch Icon display element is a special version of the Device Icon element which may be used to visualize the position of a switch in a user interface screen designed as a block diagram. The switch icon has all capabilities of a plain device icon display element. The context menu shown with this right mouse button additionally contains an option to toggle the switch position. The switch icon element -- unlike the plain device icon element -- does not support user defined images.

The attributes listed below may be configured to customize a display element of this type:

• Device name: The name of the device this element stands for. You also may enter the complete ID of the parameter which controls the switch position for devices which manage more than one switch or use a non-standard switch position parameter name.
• Icon: Select the shape of the icon from the given switch symbols or a user defined switch. .ts user defined switchThe (base-) name of a set of userdefined switch icons. See below how to use your own switch icons.
• Privilege level: The privilege level necessary to toggle the switch position. To change the device mode (OPERATIONAL, OUT-OF-SERVICE), at least a privilege of 100 is necessary, or the value set here if this is higher.
• Touch screen mode: Selecting this option makes the switch icon behave differently, optimized for touch screen usage. You may toggle the switch position by touching the icon twice. This first time you touch it, the icon shows a turquoise ball in the upper left corner. This ball disappears after 2 seconds. If you touch the icon a second time before the turquoise ball disappears, the switch is actuated. There is no right mouse button context menu in this mode, no way to go into the device screen or set the device OUT-OF-SERVICE.
• Font: Font contains two options:
  • Font: The font attribute applies to the device name, too.
  • Color: The color attribute of a parameter element sets the color of the device name shown with the icon.
• Conditionally enable widget: Parameter fields may be locked to read only state unless another parameter matches a given value. For instance, changing the position of a wave guide switch may be inhibited while the carrier is switched on. Check this to activate this feature.
  • Enable ID: This field defines the ID for the enabling parameter.
  • Enable value: The value belonging to the parameter above. The actual value of the parameter
• Query before toggling switch: Check this mark to make the element show a query before a parameter gets actually commanded.
  • Query text: The query text to be shown in the pop-up window. You may leave this field empty, the program uses a standard query text in this case. In the question text, placeholders may used for two values: Any occurrences of the pattern $P get replaced by the parameter name (message ID). Any occurrences of the pattern $V get replaced by the new value to set.

Remarks

Configuring a confirmation question as described above, only affects the 'Toggle position' function provided by the switch icon's right mouse context menu. Setting the switch position from the device dialog always works without a confirmation request.

User defined switch icons

The sat-nms software comes with 6 predefined switch icons. You may add your own icons if none of the predefined switches matches your needs.

For a user defined switch you have to create a set of ten PNG image files / icons. Each icon shows one combination of switch position and device state. All icons of a set must be of the same size, the files must be located in the images subdirectory of the sat-nms server installation and they must follow the naming scheme described below.

The file name of a switch icon consists of the user defined name, followed by a dash and a 2-character status code. All switch icons must be PNG images and end with the file suffix ".png" (lower case). The first character of the status code reflects the switch position, the second one the device's fault/operation state. The following codes are defined:

Combining the two switch positions with five device status codes results in totally 10 icons which show all possible states of a switch. If you create a switch named "myswitch", the files would be:

myswitch-AN.png myswitch-AW.png myswitch-AF.png myswitch-AS.png myswitch-AO.png myswitch-BN.png myswitch-BW.png myswitch-BF.png myswitch-BS.png myswitch-BO.png

Replacing the predefined icons

In in your sat-nms installation mostly user defined switch symbols are used, you may replace some or all of the predefined switch symbols offered by the Switch Icon dialog with your favorite icons. To configure this, edit the file "client.properties" in the base directory of the sat-nms server installation and add some or all lines of the following:

gui.editor.predefinedSwitch.1=myswitch1 (replace myswitch1 by the name of the icon set to use) gui.editor.predefinedSwitch.2=myswitch2 gui.editor.predefinedSwitch.3=myswitch3 gui.editor.predefinedSwitch.4=myswitch4 gui.editor.predefinedSwitch.5=myswitch5 gui.editor.predefinedSwitch.6=myswitch6

Please note, this does not replace / delete the factory icons. Screens which make use of the factory switches will still use them as before and you are still able to edit screens with factory switch icons by explicitly define their names in the user defined switch field. The names of the factory switch icons are wgswitch , wgswitch-mirrored , cxswitch , cxswitch-mirrored , lswitch and rswitch .

User defined switch icons may be of any size, even larger than the factory icons. When used as predefined switch icons, such large icons will show up in the dialog with their upper left corner only. In the screen the icons gets displayed with it's full size.