Differences

This shows you the differences between two versions of the page.

--- ivac2:firdef_labels [2015/06/15 17:51]
splendor.bouman [Aircraft Labels]
+++ ivac2:firdef_labels [2017/12/04 19:07] (current)
jessy.stas [Label fields]
@@ Line 1: / Line 1: @@
 ====== Aircraft Labels ======
-''DRAFT - Definitions subject to change''
+''CURRENT as of 26 MAR 2016''
 Aircraft labels are defined separately from the colours and symbols used by labels & tracks. The contents and layout of the label may be customised.
-Every FIR can specify an unlimited number of label formats. Label formats are defined by the label directory name located in fir/labels/(format_name)
+Every FIR can specify an unlimited number of label formats. Label formats are defined by the label directory name located in fir/labels/(label_name).xml
-Each named format directory groups the following files:
-  * [[ivac2:firdef_labelfields_xml|labelfields.xml]]
-  * [[ivac2:firdef_label_layout_xml|(label_state).xml]]
 ===== Label states =====
@@ Line 17: / Line 13: @@
 **Airborne labels**
-  * Unconcerned (//default - track not affecting sector//)
+  * Default (//default - track not affecting sector//)
   * Concerned (//aircraft planned to enter sector//)
   * Assumed (//aircraft assumed by sector//)
   * Released (//aircraft released by sector//)
-  * Uncorrelated (//aircraft with XPDR code not linked to a flight plan//)
   * Filtered (//label of track which is filtered by upper/lower filter//)
-The default label is the ''unconcerned'' state. This label must be defined as a minimum.
+The ''default'' label must be defined as a minimum. All further states are optional and only need to be defined if the label layout for the state differs from the ''default'' state. Note that the colours of a track/label state completely are independent.
-All further states are optional and only need to be defined if the label layout for the state differs from the ''unconcerned'' state. Note that the colours of a track/label state completely are independent.
 **Ground label**
-  * Ground ARR (//arriving aircraft//)
+  * Default (//unknown route//)
-  * Ground ARR Assumed (//as above, assumed by controller//)
+  * Arrival (//arriving aircraft//)
-  * Ground DEP (//departing aircraft//)
+  * Departure (//departing aircraft//)
-  * Ground DEP Assumed (//as above, assumed by controller//)
+  * Vehicle (//non-aircraft traffic//)
-Two defaults are required: ''Ground ARR'' and ''Ground DEP''. Further states are optional and follow the logic of the airborne labels.
+The default label must be defined as a minimum. Further states are optional and follow the logic of the airborne labels.
 ===== Label fields =====
-A huge variety of usable fields exist which can be customised to suit the desired visual presentation. Some fields also allow the selection of the unit used such as Meters/Feet or Knots/KmH
+A huge variety of usable fields exist which can be customised to suit the desired visual presentation.
-All fields may be shortened ''e.g. 23 instead of 230'' or ''NIN instead of NINTU''. A prefix may also be assigned ''e.g. G435''.
+Fields are configured with a number of variables:
+^Field^Function^
+|tag|text to show when the field is empty|
+|unselected|show the field when label is not selected|
+|prefix|character ahead of field|
+|format|field format in formatter type (see below)|
+|units|unit types see below|
+|action|single click on the field|
+|doubleaction|double click on the field|
+|info|second (right) click on the field|
+Formatters
+^Field^Function^
+||default format for field|
+|F|for altitude fields places F in front of the altitude if field is FL (F for feet or M for meter) can only be combined with %02d, %03d|
+|A|for altitude fields places A in front of the altitude if field is below TL/TA  can only be combined with %02d, %03d|
+|AF|will place a F/M/A in front of the altitude depending on it's type  can only be combined with %02d, %03d|
+|%02d|formats a field to show 2 numbers (drops last) or pads left if < 2 numbers exist|
+|%03d|formats a field to show 3 numbers (drops last) or pads left if < 3 numbers exist|
+|%04d|formats a field to show 4 numbers (drops last) or pads left if < 3 numbers exist|
+|%4s|formats a character field to take up 4 characters. number can be any numeric value|
+Units
+^identifier^Description^
+|FL|Flight level in the hundreds of steps (380, 330)|
+|FL100|Same as above|
+|FL10|Flight level in the steps of (38 for FL380 or 33 for F330)|
+|FLM|Flight level in meters (6100m becomes 61 and 11600m become 116)
+|N|Speed in knots full form|
+|KTS|Speed in knots full form|
+|KMH|Speed in km/h full form|
+|K|Speed in km/h full form|
+|N10|Speed in knots steps of ten (380 => 38)|
+|KTS10|Speed in knots steps of ten (380 => 38)|
+|KMH10|Speed in km/h steps of ten (750 => 75)|
+|K10|Speed in km/h steps of ten (750 => 75)|
+|KMH100|Speed in km/h steps of hundred (750 => 7, 1230 => 12)|
+|K100|Speed in km/h steps of hundred (750 => 7, 1230 => 12)|
-Fields may also be hidden unless the track is selected.
 ^Field ID^Description^Unit^
 |CALLSIGN|Aircraft Callsign|
+|SI|Current assumed sector|
 |TSSR|Transmitted Mode A code|
 |ASSR|Assigned Mode A code|
-|CID|
+|ALERT|Alert state e.g. EMER, COMAIL|
+|WARNING|Warning state e.g. STCD / MTCD|
+|DUPE|Duplicate code alert|
+|ROF|Request on Frequency|
 |ATYP|Aircraft Type|
 |WTC|Weight Turbulence Category|
-|AI|
+^ ^^^
-|AFL|Actual level (Mode C readout)|Meters / Feet|
+|AFL|Actual level (downlinked)|Meters / Feet|
-|CFL|Cleared level|Meters / Feet|
+|<del>DSA</del>|Selected level (downlinked)|
+|ROCD|Rate of climb / descent in ft/min|
+|GS|Ground speed (radar calculated)|
+|IC|Climb / descent arrow|
+|<del>IAS</del>|Indicated Airspeed (downlinked)|
+|<del>HDG</del>|Heading (downlinked)|
+|TRACK|Radar track|
+^ ^^^
 |RFL|Requested level from flight plan|
-|RCD|Rate of climb / descent in ft/min|
+|CFL|Cleared level|Meters / Feet|
 |CWP|Cleared waypoint / heading|
-|NCOP|Sector entry cleared waypoint|
+|ASP|Assigned Speed|
+|COPN|Sector entry cleared waypoint|
 |PEL|Sector entry level|Meters / Feet / All|
 |XCOP|Sector exit cleared waypoint|
 |XFL|Sector exit level|Meters / Feet / All|
 |NEXT|Next sector|
-|GS|Ground speed (radar calculated)|
+^ ^^^
-|ASP|
-|IAS|Indicated Airspeed (downlinked)|
-|HDG|Heading (downlinked)|
-|SFL|Selected level (downlinked)|
 |ADEP|Departure AD|
 |DRWY|Departure RWY|
+|DGATE|Departure Stand|
+|SID|Standard Departure route|
 |ADES|Arrival AD|
 |ARWY|Arrival RWY|
-|STAND|Arrival Stand|
+|AGATE|Arrival Stand|
-|STATE|
+|STAR|Standard Arrival route|
+^ ^^^
 |TEXT|Free Text field|
-|ACID|
+|TEXT2|Free Text field 2|
-|NMS|
+|<del>SPACE</del>|Blank Space|
-|ALERT|Alert state e.g. EMER, COMAIL|
+^ ^^^
-|DUPE|Duplicate code alert|
+|MODES|Mode S ID|
-|SAFE|
-|RT|
+===== Label functions =====
-|SPACE|Blank Space|
+Label fields may be used to call up functions. Three possibilities exist:
+^Field^Function^
+|ASP|Set cleared airspeed|
+|ARWY|Set arrival runway|
+|ASTAND|Set arrival stand|
+|ASSUME|Assume track|
+|CALLSIGNMENU|Open main callsign menu|
+|CFL|Set cleared level|
+|COPN|Set coordinated entry point|
+|CWP|Cleared waypoint / heading|
+|DRWY|Set departure runway|
+|DSTAND|Set departure stand|
+|EXPLT|Draw FP route|
+|FLIGHTPLAN|Show flightplan window|
+|MARK|Highlight the track locally|
+|NEXT|Set next controller|
+|NEXTME|Set me as next controller|
+|PEL|Planned entry level|
+|POINTOUT|Highlight the track for all controllers|
+|QDM|Draw QDM|
+|RELEASE|Release track to uncontrolled state|
+|RFL|Set Requested Flight Level|
+|ROF|Set "Request on Frequency" state|
+|SEP|Separation tool (VERA)|
+|SID|Set SID|
+|STAR|Set STAR|
+|TEXT|Set free text field|
+|TEXT2|Set free text2 field|
+|TRACK|Enable full track history|
+|TRANSFER|Transfer track to next controller|
+|XCOP|Exit coordination point|
+|XFL|Exit Flight Level|
 ----
 [[ivac2:firdef|Back]]