- Overview
- Display Builder
- Display Runner
- Processed Variables
- Widgets
- Actions
- Borders
- Rules
- Scripts
- Macros
- Tuning
Yamcs Studio Release Notes
Source Code Documentation
Borders¶
All widgets can show a border surrounding their bounding box. The border look is controlled by the properties Border Color, Border Width and Border Style.
The codes for these borders are:
Code |
Value |
Comment |
|---|---|---|
0 |
None |
|
1 |
Line Style |
|
2 |
Raised Style |
|
3 |
Lowered Style |
|
4 |
Etched Style |
|
5 |
Ridged Style |
|
6 |
Button Raised Style |
|
7 |
Button Pressed Style |
|
8 |
Dot Style |
|
9 |
Dash Style |
|
10 |
Dash Dot Style |
|
11 |
Dash Dot Dot Style |
|
12 |
Title Bar Style |
Title is the value of the Name property.
Title background uses Background Color.
|
13 |
Group Box Style |
Title is the value of the Name property.
Border and title background use Background Color.
Title foreground uses Border Color.
|
14 |
Round Rectangle Background |
Applies Background Color of the widget. |
15 |
Empty Background |
PV-sensitivity
When a widget is backed by a PV, the border transforms depending on the PV state.
- Connected
No decorations.
- Connected, but no value (yet)
Dotted pink border around the widget.
- Disconnected
Purple title bar with the label ‘Disconnected’ (space-permitting). This happens when there is no connection to Yamcs, or when the PV references a parameter that does not exist in the Mission Database.
- Invalid
Pink border around the widget, in the widget’s own border style. Only shown if the border property Alarm Sensitive is set (default).
For Yamcs parameters, this happens when the received value has an acquisition status other than
ACQUIRED:EXPIREDThe parameter was not updated within its expected interval, for example during loss of signal. The expected interval is derived from the rate in stream defined in the Mission Database, multiplied by the
expirationToleranceoption of the Yamcs processor (default: 1.9).INVALIDYamcs could not process the value, for example because it is outside the valid range defined in the Mission Database, or because its calibration failed.
The acquisition status of a Yamcs parameter is shown as Status in the PV Info dialog. It is only available while connected to Yamcs, and only for parameters that exist in the Mission Database. Scripts can read it with Yamcs.getAcquisitionStatus(pv).
The colors are the predefined colors Invalid and Disconnected.
Alarm-sensitivity
If the widget has the border property Alarm Sensitive set, the border transforms to a 2 pixel wide alarm border when the PV is in alarm state.
- Minor Alarm
Solid orange border around the widget
- Major Alarm
Solid red border around the widget
If the PV is connected to a Yamcs parameter, the mapping is done as follows:
WATCH, WARNING, DISTRESS → MINOR
CRITICAL, SEVERE → MAJOR