From 39290cad0a826c7c73c739c164d2ff36d102d648 Mon Sep 17 00:00:00 2001 From: malstraem Date: Wed, 19 Feb 2025 19:39:08 +0300 Subject: [PATCH] comments update --- source/library/Comments.xml | 34 ++++-- .../library/records/airspace/BoundaryPoint.cs | 2 +- .../records/airspace/ControlledVolume.cs | 16 +-- .../library/records/airspace/FlightRegion.cs | 24 ++--- .../library/records/airspace/RegionPoint.cs | 8 +- .../library/records/airspace/RegionVolume.cs | 16 +-- .../records/airspace/RestrictiveVolume.cs | 8 +- source/library/records/airspace/Spaces.cs | 24 ++--- .../records/airspace/Space{TVolume}.cs | 4 +- source/library/records/airspace/Volume.cs | 8 +- .../records/comms/AirwayCommunication.cs | 6 +- .../records/comms/AirwayTransmitter.cs | 2 +- .../library/records/comms/PortTransmitter.cs | 8 +- source/library/records/comms/Transmitter.cs | 4 +- source/library/records/ground/Airport.cs | 46 +++----- .../library/records/ground/ArrivalAltitude.cs | 9 +- source/library/records/ground/Gate.cs | 8 +- source/library/records/ground/GroundPoint.cs | 8 +- source/library/records/ground/Heliport.cs | 6 +- .../library/records/ground/MinimumAltitude.cs | 13 +-- source/library/records/ground/PathPoint.cs | 59 ++++++----- source/library/records/ground/Port.cs | 98 +++++++---------- .../library/records/ground/RunwayThreshold.cs | 20 ++-- .../library/records/ground/SatellitePoint.cs | 26 ++--- .../records/navigation/GlobalLanding.cs | 47 ++++---- .../records/navigation/InstrumentLanding.cs | 58 +++++----- .../records/navigation/InstrumentMarker.cs | 13 +-- .../records/navigation/LandingSystem.cs | 22 ++-- .../records/navigation/MicrowaveLanding.cs | 100 +++++++++--------- .../records/navigation/Nondirectional.cs | 2 +- .../records/navigation/Omnidirectional.cs | 14 +-- source/library/records/navigation/Tactical.cs | 8 +- .../records/procedures/ApproachPoint.cs | 17 +-- .../records/procedures/ApproachSequence.cs | 8 +- .../records/procedures/ArrivalPoint.cs | 13 +-- .../records/procedures/ArrivalSequence.cs | 8 +- .../records/procedures/DeparturePoint.cs | 8 +- .../records/procedures/DepartureSequence.cs | 8 +- .../records/procedures/ProcedurePoint.cs | 26 ++--- .../procedures/ProcedureSequence{TPoint}.cs | 12 +-- .../library/records/procedures/Procedures.cs | 24 ++--- source/library/records/routing/Airway.cs | 8 +- .../library/records/routing/AirwayMarker.cs | 12 +-- source/library/records/routing/AirwayPoint.cs | 32 +++--- .../library/records/routing/HoldingPattern.cs | 24 ++--- source/library/records/routing/SpecialArea.cs | 24 ++--- source/library/records/tables/CruiseRow.cs | 32 +++--- source/library/records/tables/CruiseTable.cs | 12 +-- .../records/waypoints/TerminalWaypoint.cs | 8 +- source/library/records/waypoints/Waypoint.cs | 12 +-- source/library/terms/common/Course.cs | 11 +- 51 files changed, 487 insertions(+), 533 deletions(-) diff --git a/source/library/Comments.xml b/source/library/Comments.xml index 386f347..86a17d2 100644 --- a/source/library/Comments.xml +++ b/source/library/Comments.xml @@ -11,7 +11,7 @@ Theta (THETA) field. - Degrees and tenths of degree. + Degrees. See section 5.24. @@ -19,7 +19,7 @@ Rho (RHO) field. - Nautical miles and tenths of mile. + Nautical miles. See section 5.25. @@ -27,7 +27,6 @@ Outbound Magnetic Course (OB MAG CRS) field. - Degrees and tenths of degree. See section 5.26. @@ -35,7 +34,6 @@ Inbound Magnetic Course (IB MAG CRS) field. - Degrees and tenths of degree. See section 5.28. @@ -50,7 +48,7 @@ VOR/NDB Frequency (VOR/NDB FREQ) field. - Kilohertz and tenths of kilohertz + Kilohertz. See section 5.34. @@ -58,15 +56,15 @@ Magnetic Variation (MAG VAR, D MAG VAR) field. - Degrees and tenths of degree. + Degrees. See section 5.39. - + Transition Altitude/Level (TRANS ALTITUDE/LEVEL) field. - Feet or flight level. + Feet. See section 5.53. @@ -93,6 +91,22 @@ See section 5.72. + + + Facility Elevation (FAC ELEV) field. + + Feet. + See section 5.92. + + + + + Minor Axis Bearing (MINOR AXIS TRUE BRG) field. + + Degrees. + See section 5.100. + + FIR/UIR Identifier (FIR/UIR IDENT) field. @@ -125,7 +139,7 @@ ARC Radius (ARC RAD) field. - Nautical miles and thousands of mile. + Nautical miles. See section 5.204. @@ -140,7 +154,7 @@ Ellipsoidal Height field. - Meters and tenths of meter. + Meters and tenths of a meter. See section 5.225. diff --git a/source/library/records/airspace/BoundaryPoint.cs b/source/library/records/airspace/BoundaryPoint.cs index a35825c..e0af0cc 100644 --- a/source/library/records/airspace/BoundaryPoint.cs +++ b/source/library/records/airspace/BoundaryPoint.cs @@ -3,7 +3,7 @@ namespace Arinc424.Airspace; using Terms; /** - Fields of Controlled Airspace and Restrictive Airspace. +Fields of Controlled Airspace and Restrictive Airspace. Used by and like subsequence.*/ [DebuggerDisplay($"{{{nameof(Via)}}} - {{{nameof(Coordinates)}}}")] diff --git a/source/library/records/airspace/ControlledVolume.cs b/source/library/records/airspace/ControlledVolume.cs index 6e0efb8..5aaa0df 100644 --- a/source/library/records/airspace/ControlledVolume.cs +++ b/source/library/records/airspace/ControlledVolume.cs @@ -4,10 +4,10 @@ namespace Arinc424.Airspace; using Terms; -/// -/// Controlled Airspace primary record sequence. -/// -/// Used by like subsequence. +/** +Controlled Airspace primary record sequence + +Used by like subsequence.*/ [Pipeline>] [DebuggerDisplay($"{nameof(Class)} - {{{nameof(Class)},nq}}, {nameof(Type)} - {{{nameof(Type)}}}")] @@ -17,10 +17,10 @@ public class ControlledVolume : Volume [Character(9)] public AirspaceType Type { get; set; } - /// - /// Controlled Airspace Center (ARSP CNTR) field. - /// - /// See section 5.214. + /** + Controlled Airspace Center (ARSP CNTR) field. + + See section 5.214.*/ [Type(15, 16)] [Identifier(10, 14)] public IIdentity Center { get; set; } diff --git a/source/library/records/airspace/FlightRegion.cs b/source/library/records/airspace/FlightRegion.cs index 157cae0..b3fac6f 100644 --- a/source/library/records/airspace/FlightRegion.cs +++ b/source/library/records/airspace/FlightRegion.cs @@ -2,10 +2,10 @@ namespace Arinc424.Airspace; -/// -/// Multiple FIR/UIR primary record sequences. -/// -/// See section 4.1.17.1. +/** +Multiple FIR/UIR primary record sequences. + +See section 4.1.17.1.*/ [Section('U', 'F'), Identifier(7, 10)] [Pipeline>] @@ -17,17 +17,17 @@ public class FlightRegion : Record424, IIdentity, INamed [Field(7, 10)] public string Identifier { get; set; } - /// - /// FIR/UIR Address (ADDRESS) field. - /// - /// See section 5.151. + /** + FIR/UIR Address (ADDRESS) field. + + See section 5.151.*/ [Field(11, 14)] public string Address { get; set; } - /// - /// FIR/UIR Name field. - /// - /// See section 5.125. + /** + FIR/UIR Name field. + + See section 5.125.*/ [Field(99, 123)] public string? Name { get; set; } } diff --git a/source/library/records/airspace/RegionPoint.cs b/source/library/records/airspace/RegionPoint.cs index 71a02ca..30918d9 100644 --- a/source/library/records/airspace/RegionPoint.cs +++ b/source/library/records/airspace/RegionPoint.cs @@ -1,9 +1,9 @@ namespace Arinc424.Airspace; -/// -/// Fields of FIR/UIR. -/// -/// Used by like subsequence. +/** +Fields of FIR/UIR. + +Used by like subsequence.*/ public class RegionPoint : BoundaryPoint { /// diff --git a/source/library/records/airspace/RegionVolume.cs b/source/library/records/airspace/RegionVolume.cs index 1b1a831..6d09127 100644 --- a/source/library/records/airspace/RegionVolume.cs +++ b/source/library/records/airspace/RegionVolume.cs @@ -3,10 +3,10 @@ namespace Arinc424.Airspace; -/// -/// FIR/UIR primary record sequence. -/// -/// Used by like subsequence. +/** +FIR/UIR primary record sequence. + +Used by like subsequence.*/ [Continuous(20), Pipeline>] [DebuggerDisplay($"{{{nameof(Type)},nq}}")] @@ -27,10 +27,10 @@ public class RegionVolume : Record424 [Character(30)] public Terms.AltitudeReportUnit AltitudeReportUnit { get; set; } - /// - /// FIR/UIR Entry Report (ENTRY) character. - /// - /// See section 5.124. + /** + FIR/UIR Entry Report (ENTRY) character. + + See section 5.124.*/ [Character(31)] public Bool IsEntryReport { get; set; } diff --git a/source/library/records/airspace/RestrictiveVolume.cs b/source/library/records/airspace/RestrictiveVolume.cs index 759dab6..a9b401a 100644 --- a/source/library/records/airspace/RestrictiveVolume.cs +++ b/source/library/records/airspace/RestrictiveVolume.cs @@ -2,10 +2,10 @@ namespace Arinc424.Airspace; -/// -/// Restrictive Airspace primary record sequence. -/// -/// Used by like subsequence. +/** +Restrictive Airspace primary record sequence. + +Used by like subsequence.*/ [Pipeline>] [DebuggerDisplay($"{{{nameof(Type)},nq}}")] diff --git a/source/library/records/airspace/Spaces.cs b/source/library/records/airspace/Spaces.cs index 1b5c772..aa7e62e 100644 --- a/source/library/records/airspace/Spaces.cs +++ b/source/library/records/airspace/Spaces.cs @@ -2,28 +2,28 @@ namespace Arinc424.Airspace; -/// -/// Multiple Controlled Airspace primary record sequences. -/// -/// See section 4.1.25.1. +/** +Multiple Controlled Airspace primary record sequences. + +See section 4.1.25.1.*/ [Section('U', 'C'), Pipeline] [DebuggerDisplay($"{{{nameof(Icao)},nq}}, {{{nameof(Name)},nq}}")] public class ControlledSpace : Space; -/// -/// Multiple Restrictive Airspace primary record sequences. -/// -/// See section 4.1.18.1. +/** +Multiple Restrictive Airspace primary record sequences. + +See section 4.1.18.1.*/ [Section('U', 'R'), Pipeline] [DebuggerDisplay($"{{{nameof(Icao)},nq}}, {{{nameof(Identifier)},nq}}")] public class RestrictiveSpace : Space, IIdentity { - /// - /// Restrictive Airspace Designation field. - /// - /// See section 5.129. + /** + Restrictive Airspace Designation field. + + See section 5.129.*/ [Field(10, 19)] public string Identifier { get; set; } } diff --git a/source/library/records/airspace/Space{TVolume}.cs b/source/library/records/airspace/Space{TVolume}.cs index 94557fe..4be2ca1 100644 --- a/source/library/records/airspace/Space{TVolume}.cs +++ b/source/library/records/airspace/Space{TVolume}.cs @@ -8,8 +8,8 @@ public abstract class Space : Record424, IIcao, INamed where T public Icao Icao { get; set; } /** - Restrictive Airspace Name for and - Controlled Airspace Name (ARSP NAME) for field. + Restrictive Airspace Name for and + Controlled Airspace Name (ARSP NAME) for field. See section 5.126 and 5.216.*/ [Field(94, 123)] diff --git a/source/library/records/airspace/Volume.cs b/source/library/records/airspace/Volume.cs index fc66556..45313cf 100644 --- a/source/library/records/airspace/Volume.cs +++ b/source/library/records/airspace/Volume.cs @@ -1,8 +1,6 @@ namespace Arinc424.Airspace; -/// -/// Space volume with low and up limits. -/// +/// Space volume with low and up limits. [Icao(7, 8)] public abstract class Volume : Record424, IMultiple { @@ -17,9 +15,7 @@ public abstract class Volume : Record424, IMultiple [Character(27)] public TimeCode TimeCode { get; set; } - /// - /// NOTAM character. - /// + /// NOTAM character. /// See section 5.132. [Character(28)] public char Notam { get; set; } diff --git a/source/library/records/comms/AirwayCommunication.cs b/source/library/records/comms/AirwayCommunication.cs index 8f64d55..5ae1772 100644 --- a/source/library/records/comms/AirwayCommunication.cs +++ b/source/library/records/comms/AirwayCommunication.cs @@ -2,8 +2,10 @@ namespace Arinc424.Comms; using Processing; -/// Enroute Communications primary record sequence. -/// See section 4.1.23.1. +/** +Enroute Communications primary record sequence. + +See section 4.1.23.1.*/ [Section('E', 'V'), Continuous(56)] [Pipeline>(Start = Supplement.V19)] diff --git a/source/library/records/comms/AirwayTransmitter.cs b/source/library/records/comms/AirwayTransmitter.cs index ac25330..1d45666 100644 --- a/source/library/records/comms/AirwayTransmitter.cs +++ b/source/library/records/comms/AirwayTransmitter.cs @@ -1,7 +1,7 @@ namespace Arinc424.Comms; /** - Fields of Enroute Communications. +Fields of Enroute Communications. Used by like subsequence.*/ [DebuggerDisplay($"{{{nameof(Narrative)},nq}}, {nameof(Type)} - {{{nameof(Type)}}}")] diff --git a/source/library/records/comms/PortTransmitter.cs b/source/library/records/comms/PortTransmitter.cs index ffe0df7..fd71b0c 100644 --- a/source/library/records/comms/PortTransmitter.cs +++ b/source/library/records/comms/PortTransmitter.cs @@ -3,21 +3,21 @@ namespace Arinc424.Comms; using Terms; /** - Fields of Airport Communications and Heliport Communications. +Fields of Airport Communications and Heliport Communications. Used by like subsequence.*/ [DebuggerDisplay($"{{{nameof(CallSign)},nq}}, {nameof(Type)} - {{{nameof(Type)}}}")] public class PortTransmitter : Transmitter { /** - Multi-Sector Indicator (MSEC IND) character. + Multi-Sector Indicator (MSEC IND) character. See section 5.286.*/ [Character(68, Start = Supplement.V19)] public Bool IsMultiSector { get; set; } /** - Sectorization (SECTOR) field. + Sectorization (SECTOR) field. See section 5.183.*/ [Field(63, 68), Field(69, 74, Start = Supplement.V19)] @@ -33,7 +33,7 @@ public class PortTransmitter : Transmitter public DistanceLimitation Limitation { get; set; } /** - Communications Distance (COMM DIST) field. + Communications Distance (COMM DIST) field. Nautical miles. See section 5.188.*/ diff --git a/source/library/records/comms/Transmitter.cs b/source/library/records/comms/Transmitter.cs index 12b94e4..de8b19b 100644 --- a/source/library/records/comms/Transmitter.cs +++ b/source/library/records/comms/Transmitter.cs @@ -47,9 +47,9 @@ public abstract class Transmitter : Geo, ISequenced public AltitudeDescription AltitudeDescription { get; set; } /** - Communication Altitude (COMM ALTITUDE) field. + Communication Altitude (COMM ALTITUDE) field. - Hundredth of feet. + Feet. See section 5.184.*/ [Field(70, 74), Field(84, 86, Start = Supplement.V19)] [Field(94, 98)] diff --git a/source/library/records/ground/Airport.cs b/source/library/records/ground/Airport.cs index ad94aa0..24f2717 100644 --- a/source/library/records/ground/Airport.cs +++ b/source/library/records/ground/Airport.cs @@ -4,18 +4,18 @@ namespace Arinc424.Ground; using Terms; -/// -/// Airport primary record. -/// -/// See section 4.1.7.1. +/** +Airport primary record. + +See section 4.1.7.1.*/ [Section('P', 'A', subsectionIndex: 13)] public class Airport : Port { - /// - /// Longest Runway (LONGEST RWY) field. - /// - /// Hundreds of feet. - /// See section 5.54. + /** + Longest Runway (LONGEST RWY) field. + + Feet. + See section 5.54.*/ [Field(28, 30), Integer] public int LongestRunwayLength { get; set; } @@ -23,45 +23,31 @@ public class Airport : Port [Character(32)] public SurfaceType LongestRunwayType { get; set; } - /// - /// Associated gates. - /// + /// Associated gates. [Many] public List? Gates { get; set; } - /// - /// Associated runways. - /// + /// Associated runways. [Many] public List? Thresholds { get; set; } - /// - /// Associated NDBs. - /// + /// Associated NDBs. [Many] public List? Beacons { get; set; } - /// - /// Associated VHF Navaids. - /// + /// Associated VHF Navaids. [Many] public List? Omnidirectionals { get; set; } - /// - /// Associated Localizer Markers. - /// + /// Associated Localizer Markers. [Many] public List? Markers { get; set; } - /// - /// Associated MLS. - /// + /// Associated MLS. [Many] public List? MicrowaveLandings { get; set; } - /// - /// Associated ILS. - /// + /// Associated ILS. [Many] public List? InstrumentLandings { get; set; } } diff --git a/source/library/records/ground/ArrivalAltitude.cs b/source/library/records/ground/ArrivalAltitude.cs index d28649d..ddaadd7 100644 --- a/source/library/records/ground/ArrivalAltitude.cs +++ b/source/library/records/ground/ArrivalAltitude.cs @@ -3,10 +3,10 @@ namespace Arinc424.Ground; -/// -/// Airport and Heliport TAA primary record. -/// -/// See section 4.1.31.1 and 4.2.6.1. +/** +Airport and Heliport TAA primary record. + +See section 4.1.31.1 and 4.2.6.1.*/ [Section('P', 'K', subsectionIndex: 13), Section('H', 'K', subsectionIndex: 13)] [Icao(11, 12), Port(7, 10), Continuous(30)] @@ -30,6 +30,7 @@ public class ArrivalAltitude : Record424 [Decode] public ArrivalSector[] Sectors { get; set; } + /// [Character(120)] public CourseType CourseType { get; set; } } diff --git a/source/library/records/ground/Gate.cs b/source/library/records/ground/Gate.cs index c614a61..8cd8bc6 100644 --- a/source/library/records/ground/Gate.cs +++ b/source/library/records/ground/Gate.cs @@ -1,9 +1,9 @@ namespace Arinc424.Ground; -/// -/// Airport Gate primary record. -/// -/// See section 4.1.8.1. +/** +Airport Gate primary record. + +See section 4.1.8.1.*/ [Section('P', 'B', subsectionIndex: 13), Icao(11, 12), Continuous] [DebuggerDisplay($"{{{nameof(Identifier)},nq}}, {nameof(Airport)} - {{{nameof(Airport)}}}")] diff --git a/source/library/records/ground/GroundPoint.cs b/source/library/records/ground/GroundPoint.cs index 7234c5b..a675e73 100644 --- a/source/library/records/ground/GroundPoint.cs +++ b/source/library/records/ground/GroundPoint.cs @@ -2,10 +2,10 @@ namespace Arinc424.Ground; -/// -/// GBAS Path Point primary record. -/// -/// See section 4.1.35.1. +/** +GBAS Path Point primary record. + +See section 4.1.35.1.*/ [Section('P', 'Q', subsectionIndex: 13)] public class GroundPoint : PathPoint { diff --git a/source/library/records/ground/Heliport.cs b/source/library/records/ground/Heliport.cs index c5ba71a..ec7ab49 100644 --- a/source/library/records/ground/Heliport.cs +++ b/source/library/records/ground/Heliport.cs @@ -3,7 +3,7 @@ namespace Arinc424.Ground; /** - Heliport primary record. +Heliport primary record. See section 4.2.1.1.*/ [Section('H', 'A', subsectionIndex: 13), Pipeline(End = Supplement.V21)] @@ -11,9 +11,7 @@ namespace Arinc424.Ground; [Obsolete("todo")] public class Heliport : Port { - /// - /// Associated Helipads. - /// + /// Associated Helipads. [Many] public List? Helipads { get; set; } } diff --git a/source/library/records/ground/MinimumAltitude.cs b/source/library/records/ground/MinimumAltitude.cs index dff8079..7f8e9a7 100644 --- a/source/library/records/ground/MinimumAltitude.cs +++ b/source/library/records/ground/MinimumAltitude.cs @@ -2,14 +2,14 @@ namespace Arinc424.Ground; -/// -/// Airport and Heliport MSA primary record. -/// -/// See section 4.1.20.1 and 4.2.4. +/** +Airport and Heliport MSA primary record. + +See section 4.1.20.1 and 4.2.4.*/ [Section('P', 'S', subsectionIndex: 13), Section('H', 'S', subsectionIndex: 13)] [Icao(11, 12), Port(7, 10), Continuous(39)] -public class MinimumAltitude : Record424 +public class MinimumAltitude : Record424, IMultiple { [Identifier(7, 10)] [Possible] @@ -20,11 +20,12 @@ public class MinimumAltitude : Record424 public IIdentity Center { get; set; } [Character(23)] - public char MultipleCode { get; set; } + public char? Multiplier { get; set; } [Field(43, 53), Count(7)] public Sector[] Sectors { get; set; } + /// [Character(120)] public CourseType CourseType { get; set; } } diff --git a/source/library/records/ground/PathPoint.cs b/source/library/records/ground/PathPoint.cs index 8e94b0e..88ade4c 100644 --- a/source/library/records/ground/PathPoint.cs +++ b/source/library/records/ground/PathPoint.cs @@ -4,6 +4,9 @@ namespace Arinc424.Ground; using Terms; +/** +Fields of GBAS Path Point and SBAS Path Point. +*/ [Icao(11, 12), Port(7, 10), Continuous(27)] [DebuggerDisplay($"{{{nameof(Identifier)},nq}}")] @@ -19,17 +22,17 @@ public abstract class PathPoint : Fix [Field(20, 24), Obsolete("todo")] public string AsRunway { get; set; } - /// - /// Route Indicator (RTE IND) character. - /// - /// See section 5.224. + /** + Route Indicator (RTE IND) character. + + See section 5.224.*/ [Character(28)] public char RouteIndicator { get; set; } - /// - /// Reference Path Data Selector (REF PDS) field. - /// - /// See section 5.256. + /** + Reference Path Data Selector (REF PDS) field. + + See section 5.256.*/ [Field(31, 32), Integer] public int PathSelector { get; set; } @@ -41,31 +44,31 @@ public abstract class PathPoint : Fix [Field(61, 66), Float(10)] public float EllipsoidalHeight { get; set; } - /// - /// Glide Path Angle (GPA) field. - /// - /// See section 5.226. + /** + Glide Path Angle (GPA) field. + + Degrees. + See section 5.226.*/ [Field(67, 70), Float(100)] public float GlideAngle { get; set; } - /// - /// Flight Path Alignment coordinates. - /// + /// Flight Path Alignment coordinates. [Field(71, 93)] public Coordinates AlignmentCoordinates { get; set; } - /// - /// Course Width At Threshold (CRS WDTH) field. - /// - /// Meters. - /// See section 5.228. + /** + Course Width At Threshold (CRS WDTH) field. + + Meters. + See section 5.228.*/ [Field(94, 98), Float(100)] public float CourseWidth { get; set; } - /// - /// Length Offset (OFFSET) field. - /// - /// See section 5.259. + /** + Length Offset (OFFSET) field. + + Meters. + See section 5.259.*/ [Field(99, 102), Integer] public int LengthOffset { get; set; } @@ -73,10 +76,10 @@ public abstract class PathPoint : Fix [Field(103, 109)] public ThresholdHeight ThresholdHeight { get; set; } - /// - /// Final Approach Segment Data CRC Remainder (FAS CRC) field. - /// - /// See section 5.229. + /** + Final Approach Segment Data CRC Remainder (FAS CRC) field. + + See section 5.229.*/ [Obsolete("need to convert?")] [Field(116, 123)] public string Remainder { get; set; } diff --git a/source/library/records/ground/Port.cs b/source/library/records/ground/Port.cs index fd58520..de7807e 100644 --- a/source/library/records/ground/Port.cs +++ b/source/library/records/ground/Port.cs @@ -10,24 +10,24 @@ namespace Arinc424.Ground; [DebuggerDisplay($"{{{nameof(Identifier)},nq}}, {nameof(Name)} - {{{nameof(Name)},nq}}")] public abstract class Port : Fix, INamed { - /// - /// ATA/IATA Designator (ATA/IATA) field. - /// - /// See section 5.107. + /** + ATA/IATA Designator (ATA/IATA) field. + + See section 5.107.*/ [Field(14, 16)] public string? Designator { get; set; } - /// - /// Speed Limit Altitude field. - /// - /// See section 5.73. + /** + Speed Limit Altitude field. + + See section 5.73.*/ [Field(23, 27)] public Altitude Limit { get; set; } - /// - /// IFR Capability (IFR) character. - /// - /// See section 5.108. + /** + IFR Capability (IFR) character. + + See section 5.108.*/ [Character(31)] public Bool IsProcedurePublished { get; set; } @@ -35,11 +35,11 @@ public abstract class Port : Fix, INamed [Field(52, 56), Variation] public float Variation { get; set; } - /// - /// Airport/Heliport Elevation (ELEV) field. - /// - /// Feet. - /// See section 5.55. + /** + Airport/Heliport Elevation (ELEV) field. + + Feet. + See section 5.55.*/ [Field(57, 61), Integer] public int Elevation { get; set; } @@ -47,35 +47,31 @@ public abstract class Port : Fix, INamed [Field(62, 64), Integer] public int SpeedLimit { get; set; } - /// - /// Recommended NAVAID (RECD NAV) field. - /// + /// Recommended NAVAID (RECD NAV) field. [Identifier(65, 68), Icao(69, 70)] public Omnidirectional? Recommended { get; set; } - /// + /// [Field(71, 75), Integer] - public int TransitionAltitude { get; set; } + public int? TransitionAltitude { get; set; } - /// + /// [Field(76, 80), Integer] - public int TransitionLevel { get; set; } + public int? TransitionLevel { get; set; } /// [Character(81)] public Privacy Privacy { get; set; } - /// - /// Time Zone field. - /// + /// Time Zone field. /// See section 5.178. [Field(82, 84)] public string? TimeZone { get; set; } - /// - /// Daylight Time Indicator (DAY TIME) character. - /// - /// See section 5.179. + /** + Daylight Time Indicator (DAY TIME) character. + + See section 5.179.*/ [Character(85)] public Bool IsDaylightTime { get; set; } @@ -91,63 +87,43 @@ public abstract class Port : Fix, INamed [Field(94, 123)] public string? Name { get; set; } - /// - /// Associated GBAS points. - /// + /// Associated GBAS points. [Many] public List? GroundPoints { get; set; } - /// - /// Associated SBAS points. - /// + /// Associated SBAS points. [Many] public List? SatellitePoints { get; set; } - /// - /// Associated GLSs. - /// + /// Associated GLSs. [Many] public List? GlobalLandings { get; set; } - /// - /// Associated STARs. - /// + /// Associated STARs. [Many] public List? Arrivals { get; set; } - /// - /// Associated Approach Procedures. - /// + /// Associated Approach Procedures. [Many] public List? Approaches { get; set; } - /// - /// Associated SIDs. - /// + /// Associated SIDs. [Many] public List? Departures { get; set; } - /// - /// Associated Communications. - /// + /// Associated Communications. [Many] public List? Communications { get; set; } - /// - /// Associated TAAs. - /// + /// Associated TAAs. [Many] public List? ArrivalAltitudes { get; set; } - /// - /// Associated MSAs. - /// + /// Associated MSAs. [Many] public List? MinimumAltitudes { get; set; } - /// - /// Associated Terminal Waypoints. - /// + /// Associated Terminal Waypoints. [Many] public List? TerminalWaypoints { get; set; } } diff --git a/source/library/records/ground/RunwayThreshold.cs b/source/library/records/ground/RunwayThreshold.cs index b12eef4..7690742 100644 --- a/source/library/records/ground/RunwayThreshold.cs +++ b/source/library/records/ground/RunwayThreshold.cs @@ -3,7 +3,7 @@ namespace Arinc424.Ground; /** - Runway primary record. +Runway primary record. See section 4.1.10.1.*/ [Section('P', 'G', subsectionIndex: 13)] @@ -17,7 +17,7 @@ public class RunwayThreshold : Fix public Airport Airport { get; set; } /** - Runway Length (RUNWAY LENGTH) field. + Runway Length (RUNWAY LENGTH) field. Feet. See section 5.57.*/ @@ -25,17 +25,17 @@ public class RunwayThreshold : Fix public int Length { get; set; } /** - Runway Magnetic Bearing (RWY BRG) field. + Runway Bearing (RWY BRG) field. - Degrees and tenths of a degree. + Degrees. See section 5.58.*/ [Field(28, 31)] public Course Bearing { get; set; } /** - Runway Gradient (RWY GRAD) field. + Runway Gradient (RWY GRAD) field. - Degrees and thousands of degrees. + Degrees. See section 5.212.*/ [Field(52, 56), Float(1000)] [Obsolete("todo")] @@ -46,7 +46,7 @@ public class RunwayThreshold : Fix public float EllipsoidalHeight { get; set; } /** - Landing Threshold Elevation (LANDING THRES ELEV) field. + Landing Threshold Elevation (LANDING THRES ELEV) field. Feet. See section 5.68.*/ @@ -54,7 +54,7 @@ public class RunwayThreshold : Fix public int Elevation { get; set; } /** - Threshold Displacement Distance (DSPLCD THR) field. + Threshold Displacement Distance (DSPLCD THR) field. Feet. See section 5.69.*/ @@ -74,7 +74,7 @@ public class RunwayThreshold : Fix public Terms.ThresholdType Type { get; set; } /** - Stopway field. + Stopway field. Feet. See section 5.79.*/ @@ -86,7 +86,7 @@ public class RunwayThreshold : Fix public int Height { get; set; } /** - Runway Description (RUNWAY DESCRIPTION) field. + Runway Description (RUNWAY DESCRIPTION) field. See section 5.59.*/ [Field(102, 123)] diff --git a/source/library/records/ground/SatellitePoint.cs b/source/library/records/ground/SatellitePoint.cs index f9b5eb3..f621ced 100644 --- a/source/library/records/ground/SatellitePoint.cs +++ b/source/library/records/ground/SatellitePoint.cs @@ -2,10 +2,10 @@ namespace Arinc424.Ground; -/// -/// SBAS Path Point primary record. -/// -/// See section 4.1.28.1 and 4.2.8.1. +/** +SBAS Path Point primary record. + +See section 4.1.28.1 and 4.2.8.1.*/ [Section('P', 'P', subsectionIndex: 13), Section('H', 'P', subsectionIndex: 13)] public class SatellitePoint : PathPoint { @@ -17,17 +17,19 @@ public class SatellitePoint : PathPoint [Field(29, 30)] public SatelliteService Service { get; set; } - /// - /// HAL field. - /// - /// See section 5.263. + /** + HAL field. + + Meters. + See section 5.263.*/ [Field(110, 112), Float(10)] public float HorizontalAlert { get; set; } - /// - /// VAL field. - /// - /// See section 5.264. + /** + VAL field. + + Meters. + See section 5.264.*/ [Field(113, 115), Float(10)] public float VerticalAlert { get; set; } } diff --git a/source/library/records/navigation/GlobalLanding.cs b/source/library/records/navigation/GlobalLanding.cs index 198b299..1663f04 100644 --- a/source/library/records/navigation/GlobalLanding.cs +++ b/source/library/records/navigation/GlobalLanding.cs @@ -1,38 +1,35 @@ namespace Arinc424.Navigation; -/// -/// GLS primary record. -/// -/// See section 4.1.29.1. +/** +GLS primary record. + +See section 4.1.29.1.*/ [Section('P', 'T', subsectionIndex: 13)] public class GlobalLanding : LandingSystem { - /// - /// GLS Channel field. - /// + /// GLS Channel field. /// See section 5.244. [Field(23, 27), Integer] public int Channel { get; set; } - /// - /// Service Volume Radius field. - /// - /// See section 5.245. + /** + Service Volume Radius field. + + Nautical miles. + See section 5.245.*/ [Field(84, 85), Integer] public int Radius { get; set; } - /// - /// TDMA Slots field. - /// + /// TDMA Slots field. /// See section 5.246. [Field(86, 87), Decode] public byte Slots { get; set; } - /// - /// Glide Slope Angle (GS ANGLE) field. - /// - /// Degrees and hundredths of degree. - /// See section 5.52. + /** + Glide Slope Angle (GS ANGLE) field. + + Degrees. + See section 5.52.*/ [Field(88, 90), Float(100)] public float SlopeAngle { get; set; } @@ -44,17 +41,17 @@ public class GlobalLanding : LandingSystem [Field(103, 105)] public string? Datum { get; set; } - /// - /// Station Type field. - /// + /// Station Type field. /// See section 5.247. [Obsolete("todo")] [Field(106, 108)] public string? StationType { get; set; } - /// - /// Station Elevation WGS84 field. - /// + /** + Station Elevation WGS84 field. + + Feet. + See section 5.248.*/ [Field(111, 115), Integer] public int ElevationWgs84 { get; set; } } diff --git a/source/library/records/navigation/InstrumentLanding.cs b/source/library/records/navigation/InstrumentLanding.cs index defcfe1..9ef624d 100644 --- a/source/library/records/navigation/InstrumentLanding.cs +++ b/source/library/records/navigation/InstrumentLanding.cs @@ -1,55 +1,55 @@ namespace Arinc424.Navigation; -/// -/// Airport and Heliport Localizer and Glide Slope primary record. -/// -/// See section 4.1.11.1. +/** +Airport and Heliport Localizer and Glide Slope primary record. + +See section 4.1.11.1.*/ [Section('P', 'I', subsectionIndex: 13)] public class InstrumentLanding : LandingSystem { - /// - /// Localizer Frequency (FREQ) field. - /// - /// Kilohertz. - /// See section 5.45. + /** + Localizer Frequency (FREQ) field. + + Kilohertz. + See section 5.45.*/ [Field(23, 27), Decode] public int Frequency { get; set; } [Field(56, 74)] public Coordinates GlideSlopeCoordinates { get; set; } - /// - /// Localizer Position (LOC FR RW END) field. - /// - /// Feet. - /// See section 5.48. + /** + Localizer Position (LOC FR RW END) field. + + Feet. + See section 5.48.*/ [Field(75, 78), Integer] public int Position { get; set; } [Character(79), Obsolete("todo - combine with position")] public char PositionReference { get; set; } - /// - /// Glide Slope Position (GS FR RW THRES) field. - /// - /// Feet. - /// See section 5.50. + /** + Glide Slope Position (GS FR RW THRES) field. + + Feet. + See section 5.50.*/ [Field(80, 83), Integer] public int GlideSlopePosition { get; set; } - /// - /// Localizer Width (LOC WIDTH) field. - /// - /// Degrees and hundredths of degree. - /// See section 5.51. + /** + Localizer Width (LOC WIDTH) field. + + Degrees. + See section 5.51.*/ [Field(84, 87), Float(100)] public float Width { get; set; } - /// - /// Glide Slope Angle (GS ANGLE) field. - /// - /// Degrees and hundredths of degree. - /// See section 5.52. + /** + Glide Slope Angle (GS ANGLE) field. + + Degrees. + See section 5.52.*/ [Field(88, 90), Float(100)] public float SlopeAngle { get; set; } diff --git a/source/library/records/navigation/InstrumentMarker.cs b/source/library/records/navigation/InstrumentMarker.cs index 9b93a9b..b6b4ce4 100644 --- a/source/library/records/navigation/InstrumentMarker.cs +++ b/source/library/records/navigation/InstrumentMarker.cs @@ -5,7 +5,7 @@ namespace Arinc424.Navigation; using Terms; /** - Airport and Heliport Localizer Marker primary record. +Airport and Heliport Localizer Marker primary record. See section 4.1.13.1.*/ [Section('P', 'M', subsectionIndex: 13), Icao(11, 12), Port(7, 10), Continuous] @@ -30,6 +30,7 @@ public class InstrumentMarker : Fix [Identifier(28, 32)] public RunwayThreshold Threshold { get; set; } + /// [Field(52, 55), Float(10)] public float Bearing { get; set; } @@ -55,6 +56,10 @@ public class InstrumentMarker : Fix [Field(80, 84), Obsolete("need more section 5.93 analysis")] public string? Facility { get; set; } + /** + VOR/NDB Identifier (VOR IDENT/NDB IDENT) field. + + See section 5.33.*/ [Field(85, 88)] public string? LocatorIdentifier { get; set; } @@ -62,11 +67,7 @@ public class InstrumentMarker : Fix [Field(91, 95), Variation] public float Variation { get; set; } - /** - Facility Elevation (FAC ELEV) field. - - Feet. - See section 5.92.*/ + /// [Field(98, 102), Integer] public int Elevation { get; set; } } diff --git a/source/library/records/navigation/LandingSystem.cs b/source/library/records/navigation/LandingSystem.cs index 818c92b..7f3603b 100644 --- a/source/library/records/navigation/LandingSystem.cs +++ b/source/library/records/navigation/LandingSystem.cs @@ -17,18 +17,22 @@ public abstract class LandingSystem : Fix [Identifier(28, 32)] public RunwayThreshold Threshold { get; set; } - /// - /// Localizer Bearing (LOC BRG) and MLS Azimuth Bearing (MLS AZ BRG) field. - /// - /// Degrees and tenths of a degree. - /// See section 5.47 and 5.167. + /** + + Localizer Bearing (LOC BRG) field for and . + + + MLS Azimuth Bearing (MLS AZ BRG) field for . + + + See section 5.47 and 5.167.*/ [Field(52, 55)] public Course Bearing { get; set; } - /// - /// Component Elevation field. - /// - /// See section 5.74. + /** + Component Elevation field. + + See section 5.74.*/ [Field(98, 102), Integer] [Field(104, 108)] public int Elevation { get; set; } diff --git a/source/library/records/navigation/MicrowaveLanding.cs b/source/library/records/navigation/MicrowaveLanding.cs index 6e2f7bf..9b2b84d 100644 --- a/source/library/records/navigation/MicrowaveLanding.cs +++ b/source/library/records/navigation/MicrowaveLanding.cs @@ -1,15 +1,13 @@ namespace Arinc424.Navigation; -/// -/// Airport and Heliport MLS (Azimuth, Elevation and Back Azimuth) primary record. -/// -/// See section 4.1.22.1. +/** +Airport and Heliport MLS (Azimuth, Elevation and Back Azimuth) primary record. + +See section 4.1.22.1.*/ [Section('P', 'L', subsectionIndex: 13)] public class MicrowaveLanding : LandingSystem { - /// - /// Channel field. - /// + /// Channel field. /// See section 5.166. [Field(23, 25), Integer] public int Channel { get; set; } @@ -17,11 +15,11 @@ public class MicrowaveLanding : LandingSystem [Field(56, 74)] public Coordinates ElevationCoordinates { get; set; } - /// - /// Azimuth/Back Azimuth Position (AZ/BAZ FR RW END) field. - /// - /// Feet. - /// See section 5.48. + /** + Azimuth/Back Azimuth Position (AZ/BAZ FR RW END) field. + + Feet. + See section 5.48.*/ [Field(75, 78), Integer] public int Position { get; set; } @@ -32,50 +30,51 @@ public class MicrowaveLanding : LandingSystem [Character(79), Obsolete("TODO combine with position")] public char PositionReference { get; set; } - /// - /// Elevation Position (EL FR RW THRES) field. - /// - /// See section 5.50. + /** + Elevation Position (EL FR RW THRES) field. + + Feet. + See section 5.50.*/ [Field(80, 83), Integer] public int ElevationPosition { get; set; } - /// - /// Azimuth Proportional Angle Right (AZ PRO RIGHT) field. - /// - /// Degrees. - /// See section 5.168. + /** + Azimuth Proportional Angle Right (AZ PRO RIGHT) field. + + Degrees. + See section 5.168.*/ [Field(84, 86), Integer] public int RightAngle { get; set; } - /// - /// Azimuth Proportional Angle Left (AZ PRO LEFT) field. - /// - /// Degrees. - /// See section 5.168. + /** + Azimuth Proportional Angle Left (AZ PRO LEFT) field. + + Degrees. + See section 5.168.*/ [Field(87, 89), Integer] public int LeftAngle { get; set; } - /// - /// Azimuth Coverage Sector Right (AZ COV RIGHT) field. - /// - /// Degrees. - /// See section 5.172. + /** + Azimuth Coverage Sector Right (AZ COV RIGHT) field. + + Degrees. + See section 5.172.*/ [Field(90, 92), Integer] public int RightCoverage { get; set; } - /// - /// Azimuth Coverage Sector Left (AZ COV LEFT) field. - /// - /// Degrees. - /// See section 5.172. + /** + Azimuth Coverage Sector Left (AZ COV LEFT) field. + + Degrees. + See section 5.172.*/ [Field(93, 95), Integer] public int LeftCoverage { get; set; } - /// - /// Elevation Angle Span (EL ANGLE SPAN) field. - /// - /// Degrees and tenths of degree. - /// See section 5.169. + /** + Elevation Angle Span (EL ANGLE SPAN) field. + + Degrees. + See section 5.169.*/ [Field(96, 98), Float(10)] public float AngleSpan { get; set; } @@ -83,18 +82,19 @@ public class MicrowaveLanding : LandingSystem [Field(99, 103), Variation] public float Variation { get; set; } - /// - /// Nominal Elevation Angle (NOM ELEV ANGLE) field. - /// - /// Degrees and hundredths of degree. - /// See section 5.173. + /** + Nominal Elevation Angle (NOM ELEV ANGLE) field. + + Degrees. + See section 5.173.*/ [Field(109, 112), Float(100)] public float NominalElevationAngle { get; set; } - /// - /// Glide Slope Angle (GS ANGLE) field. - /// - /// See section 5.52. + /** + Glide Slope Angle (GS ANGLE) field. + + Degrees. + See section 5.52.*/ [Field(113, 115), Float(100)] public float MinimumGlideAngle { get; set; } diff --git a/source/library/records/navigation/Nondirectional.cs b/source/library/records/navigation/Nondirectional.cs index 8cd9438..86e3944 100644 --- a/source/library/records/navigation/Nondirectional.cs +++ b/source/library/records/navigation/Nondirectional.cs @@ -3,7 +3,7 @@ namespace Arinc424.Navigation; using Terms; /** - NDB Navaid primary record. +NDB Navaid primary record. See section 4.1.3.1.*/ [Section('D', 'B'), Icao(20, 21)] diff --git a/source/library/records/navigation/Omnidirectional.cs b/source/library/records/navigation/Omnidirectional.cs index 580efa3..ff5fbf2 100644 --- a/source/library/records/navigation/Omnidirectional.cs +++ b/source/library/records/navigation/Omnidirectional.cs @@ -5,7 +5,7 @@ namespace Arinc424.Navigation; using Terms; /** - VHF NAVAID primary record. +VHF NAVAID primary record. See section 4.1.2.1.*/ [Section('D'), /*Port(7, 10) need more analysis */ Icao(20, 21)] @@ -31,7 +31,7 @@ public class Omnidirectional : Navaid public OmnidirectCollocation Collocation { get; set; } /** - DME Identifier (DME IDENT) field. + DME Identifier (DME IDENT) field. See section 5.38.*/ [Field(52, 55)] @@ -45,7 +45,7 @@ public class Omnidirectional : Navaid public Declination Declination { get; set; } /** - DME Elevation (DME ELEV) field. + DME Elevation (DME ELEV) field. See section 5.40.*/ [Field(80, 84), Integer] @@ -56,15 +56,15 @@ public class Omnidirectional : Navaid public UsableRange Range { get; set; } /** - ILS/DME Bias field. + ILS/DME Bias field. - Nautical miles and tenths of mile. + Nautical miles. See section 5.90.*/ [Field(86, 87), Float(10)] public float EquipmentOffset { get; set; } /** - Frequency Protection Distance (FREQ PRD) field. + Frequency Protection Distance (FREQ PRD) field. Nautical miles. See section 5.150.*/ @@ -72,7 +72,7 @@ public class Omnidirectional : Navaid public int ProtectionDistance { get; set; } /** - Route Inappropriate Navaid Indicator character. + Route Inappropriate Navaid Indicator character. See section 5.297.*/ [Character(122, Start = Supplement.V20)] diff --git a/source/library/records/navigation/Tactical.cs b/source/library/records/navigation/Tactical.cs index 574e127..45dd6bd 100644 --- a/source/library/records/navigation/Tactical.cs +++ b/source/library/records/navigation/Tactical.cs @@ -4,10 +4,10 @@ namespace Arinc424.Navigation; using Terms; -/// -/// TACAN-Only NAVAID primary record. -/// -/// See section 4.1.32.1. +/** +TACAN-Only NAVAID primary record. + +See section 4.1.32.1.*/ [Section('D', 'T'), Port(7, 10), Icao(11, 12)] public class Tactical : Navaid { diff --git a/source/library/records/procedures/ApproachPoint.cs b/source/library/records/procedures/ApproachPoint.cs index 057c9d3..ebb7ca9 100644 --- a/source/library/records/procedures/ApproachPoint.cs +++ b/source/library/records/procedures/ApproachPoint.cs @@ -2,16 +2,17 @@ namespace Arinc424.Procedures; -/// -/// Fields of Airport and Heliport Approach. -/// -/// Used by like subsequence. +/** +Fields of Airport and Heliport Approach. + +Used by like subsequence.*/ public class ApproachPoint : ProcedurePoint { - /// - /// Vertical Angle (VERT ANGLE) field. - /// - /// See section 5.70. + /** + Vertical Angle (VERT ANGLE) field. + + Degrees. + See section 5.70.*/ [Field(103, 106), Float(100)] public float VerticalAngle { get; set; } diff --git a/source/library/records/procedures/ApproachSequence.cs b/source/library/records/procedures/ApproachSequence.cs index 5cb977f..7a0a76b 100644 --- a/source/library/records/procedures/ApproachSequence.cs +++ b/source/library/records/procedures/ApproachSequence.cs @@ -2,10 +2,10 @@ namespace Arinc424.Procedures; -/// -/// Airport and Heliport Approach primary record sequence. -/// -/// Used by like subsequence. +/** +Airport and Heliport Approach primary record sequence. + +Used by like subsequence.*/ [Pipeline>] public class ApproachSequence : ProcedureSequence { diff --git a/source/library/records/procedures/ArrivalPoint.cs b/source/library/records/procedures/ArrivalPoint.cs index e7f3f4c..ab57f51 100644 --- a/source/library/records/procedures/ArrivalPoint.cs +++ b/source/library/records/procedures/ArrivalPoint.cs @@ -2,16 +2,13 @@ namespace Arinc424.Procedures; -/// -/// Fields of Airport and Heliport STAR. -/// -/// Used by like subsequence. +/** +Fields of Airport and Heliport STAR. + +Used by like subsequence.*/ public class ArrivalPoint : ProcedurePoint { - /// - /// Vertical Angle (VERT ANGLE) field. - /// - /// See section 5.70. + /// [Field(103, 106), Float(100)] public float VerticalAngle { get; set; } diff --git a/source/library/records/procedures/ArrivalSequence.cs b/source/library/records/procedures/ArrivalSequence.cs index f333084..fc0408b 100644 --- a/source/library/records/procedures/ArrivalSequence.cs +++ b/source/library/records/procedures/ArrivalSequence.cs @@ -2,10 +2,10 @@ namespace Arinc424.Procedures; -/// -/// Airport and Heliport STAR primary record sequence. -/// -/// Used by like subsequence. +/** +Airport and Heliport STAR primary record sequence. + +Used by like subsequence.*/ [Pipeline>] public class ArrivalSequence : ProcedureSequence { diff --git a/source/library/records/procedures/DeparturePoint.cs b/source/library/records/procedures/DeparturePoint.cs index c3b4e67..6b42615 100644 --- a/source/library/records/procedures/DeparturePoint.cs +++ b/source/library/records/procedures/DeparturePoint.cs @@ -2,10 +2,10 @@ namespace Arinc424.Procedures; -/// -/// Fields of Airport and Heliport SID. -/// -/// Used by like subsequence. +/** +Fields of Airport and Heliport SID. + +Used by like subsequence.*/ public class DeparturePoint : ProcedurePoint { /// diff --git a/source/library/records/procedures/DepartureSequence.cs b/source/library/records/procedures/DepartureSequence.cs index b6672f8..de093fb 100644 --- a/source/library/records/procedures/DepartureSequence.cs +++ b/source/library/records/procedures/DepartureSequence.cs @@ -2,10 +2,10 @@ namespace Arinc424.Procedures; -/// -/// Airport and Heliport SID primary record sequence. -/// -/// Used by like subsequence. +/** +Airport and Heliport SID primary record sequence. + +Used by like subsequence.*/ [Pipeline>] public class DepartureSequence : ProcedureSequence { diff --git a/source/library/records/procedures/ProcedurePoint.cs b/source/library/records/procedures/ProcedurePoint.cs index a762f72..f477994 100644 --- a/source/library/records/procedures/ProcedurePoint.cs +++ b/source/library/records/procedures/ProcedurePoint.cs @@ -3,9 +3,7 @@ namespace Arinc424.Procedures; -/// -/// Fields of Airport and Heliport SID/STAR/Approach. -/// +/// Fields of SID/STAR/Approach. [Port(7, 10)] [DebuggerDisplay($"{nameof(Fix)} - {{{nameof(Fix)}}}")] @@ -35,9 +33,7 @@ public abstract class ProcedurePoint : Record424, ISequenced [Field(48, 49)] public Terms.LegType LegType { get; set; } - /// - /// Turn Direction Valid (TDV) character. - /// + /// Turn Direction Valid (TDV) character. /// See section 5.22. [Character(50)] public Bool IsTurnRequired { get; set; } @@ -62,10 +58,10 @@ public abstract class ProcedurePoint : Record424, ISequenced [Field(71, 74)] public Course Course { get; set; } - /// - /// Route Distance From, Holding Distance/Time (RTE DIST FROM, HOLD DIST/TIME) field. - /// - /// See section 5.27. + /** + Route Distance From, Holding Distance/Time (RTE DIST FROM, HOLD DIST/TIME) field. + + See section 5.27.*/ [Field(75, 78)] public string? DistanceTiming { get; set; } @@ -77,11 +73,11 @@ public abstract class ProcedurePoint : Record424, ISequenced [Character(83)] public AltitudeDescription AltitudeDescription { get; set; } - /// - /// ATC Indicator (ATC) character. - /// - /// See section 5.81. - [Character(84)] + /** + ATC Indicator (ATC) character. + + See section 5.81.*/ + [Character(84), Obsolete("bool")] public char AtcIndicator { get; set; } /// diff --git a/source/library/records/procedures/ProcedureSequence{TPoint}.cs b/source/library/records/procedures/ProcedureSequence{TPoint}.cs index 66a4b6d..b5b155c 100644 --- a/source/library/records/procedures/ProcedureSequence{TPoint}.cs +++ b/source/library/records/procedures/ProcedureSequence{TPoint}.cs @@ -1,15 +1,13 @@ namespace Arinc424.Procedures; -/// -/// Airport and Heliport SID/STAR/Approach primary record sequence. -/// -/// See section 4.1.9.1 and 4.2.3.1. +/** +SID/STAR/Approach primary record sequence. + +See section 4.1.9.1 and 4.2.3.1.*/ [DebuggerDisplay($"{nameof(Transition)} - {{{nameof(Transition)},nq}}")] public abstract class ProcedureSequence : Record424 where TPoint : ProcedurePoint { - /// - /// Transition Identifier (TRANS IDENT) field. - /// + /// Transition Identifier (TRANS IDENT) field. /// See section 5.11. [Field(21, 25)] public string? Transition { get; set; } diff --git a/source/library/records/procedures/Procedures.cs b/source/library/records/procedures/Procedures.cs index c96dcdb..0b808b5 100644 --- a/source/library/records/procedures/Procedures.cs +++ b/source/library/records/procedures/Procedures.cs @@ -3,19 +3,19 @@ namespace Arinc424.Procedures; -/// -/// Multiple Airport and Heliport STAR primary record sequences under same identifier. -/// -/// See section 4.1.9.1 and 4.2.3.1. +/** +Multiple Airport and Heliport STAR primary record sequences under same identifier. + +See section 4.1.9.1 and 4.2.3.1.*/ [Section('P', 'E', subsectionIndex: 13), Section('H', 'E', subsectionIndex: 13)] [Pipeline>] public class Arrival : Procedure; -/// -/// Multiple Airport and Heliport Approach primary record sequences under same identifier. -/// -/// See section 4.1.9.1 and 4.2.3.1. +/** +Multiple Airport and Heliport Approach primary record sequences under same identifier. + +See section 4.1.9.1 and 4.2.3.1.*/ [Section('P', 'F', subsectionIndex: 13), Section('H', 'F', subsectionIndex: 13)] [Pipeline>] @@ -28,10 +28,10 @@ public class Approach : Procedure public SatellitePoint? SatellitePoint { get; set; } } -/// -/// Multiple Airport and Heliport SID primary record sequences under same identifier. -/// -/// See section 4.1.9.1 and 4.2.3.1. +/** +Multiple Airport and Heliport SID primary record sequences under same identifier. + +See section 4.1.9.1 and 4.2.3.1.*/ [Section('P', 'D', subsectionIndex: 13), Section('H', 'D', subsectionIndex: 13)] [Pipeline>] diff --git a/source/library/records/routing/Airway.cs b/source/library/records/routing/Airway.cs index d2360ae..74ff62b 100644 --- a/source/library/records/routing/Airway.cs +++ b/source/library/records/routing/Airway.cs @@ -2,10 +2,10 @@ namespace Arinc424.Routing; -/// -/// Enroute Airways primary record sequence. -/// -/// See section 4.1.6.1. +/** +Enroute Airways primary record sequence. + +See section 4.1.6.1.*/ [Section('E', 'R'), Identifier(14, 18), Continuous(39)] [Pipeline>] diff --git a/source/library/records/routing/AirwayMarker.cs b/source/library/records/routing/AirwayMarker.cs index 32c7859..16bac3d 100644 --- a/source/library/records/routing/AirwayMarker.cs +++ b/source/library/records/routing/AirwayMarker.cs @@ -3,7 +3,7 @@ namespace Arinc424.Routing; using Terms; /** - Airways Marker primary record. +Airways Marker primary record. See section 4.1.15.1.*/ [Section('E', 'M'), Identifier(14, 17), Continuous] @@ -12,7 +12,7 @@ namespace Arinc424.Routing; public class AirwayMarker : Fix, INamed { /** - Marker Code (MARKER CODE) field. + Marker Code (MARKER CODE) field. See section 5.111.*/ [Field(23, 26)] @@ -26,7 +26,7 @@ public class AirwayMarker : Fix, INamed [Character(29)] public MarkerPower Power { get; set; } - /// Minor Axis Bearing (MINOR AXIS TRUE BRG) field. + /// [Field(52, 55), Float(10)] public float Bearing { get; set; } @@ -34,11 +34,7 @@ public class AirwayMarker : Fix, INamed [Field(75, 79), Variation] public float Variation { get; set; } - /** - Facility Elevation (FAC ELEV) field. - - Feet. - See section 5.92.*/ + /// [Field(80, 84), Integer] public int Elevation { get; set; } diff --git a/source/library/records/routing/AirwayPoint.cs b/source/library/records/routing/AirwayPoint.cs index 98688e0..fe24125 100644 --- a/source/library/records/routing/AirwayPoint.cs +++ b/source/library/records/routing/AirwayPoint.cs @@ -5,10 +5,10 @@ namespace Arinc424.Routing; -/// -/// Fields of Enroute Airways primary record. -/// -/// Used by like subsequence. +/** +Fields of Enroute Airways primary record. + +Used by like subsequence.*/ [Pipeline] [DebuggerDisplay($"{nameof(Fix)} - {{{nameof(Fix)}}}")] @@ -45,9 +45,7 @@ public class AirwayPoint : Record424, ISequenced [Identifier(48, 49)] public CruiseTable? CruiseTable { get; set; } - /// - /// EU Indicator (EU IND) character. - /// + /// EU Indicator (EU IND) character. /// See section 5.164. [Character(50)] public Bool HasRestrictions { get; set; } @@ -71,11 +69,11 @@ public class AirwayPoint : Record424, ISequenced [Field(71, 74)] public Course Out { get; set; } - /// - /// Route Distance From (RTE DIST FROM) field. - /// - /// Nautical miles and tenths of mile. - /// See section 5.27. + /** + Route Distance From (RTE DIST FROM) field. + + Nautical miles. + See section 5.27.*/ [Field(75, 78), Float(10)] public float DistanceFrom { get; set; } @@ -95,11 +93,11 @@ public class AirwayPoint : Record424, ISequenced [Field(94, 98)] public Altitude Maximum { get; set; } - /// - /// Fixed Radius Transition Indicator (FIXED RAD IND) field. - /// - /// Nautical miles and tenths of mile. - /// See section 5.254 + /** + Fixed Radius Transition Indicator (FIXED RAD IND) field. + + Nautical miles. + See section 5.254*/ [Field(99, 101), Float(10)] public float FixRadius { get; set; } diff --git a/source/library/records/routing/HoldingPattern.cs b/source/library/records/routing/HoldingPattern.cs index 2330432..63afdc6 100644 --- a/source/library/records/routing/HoldingPattern.cs +++ b/source/library/records/routing/HoldingPattern.cs @@ -1,7 +1,7 @@ namespace Arinc424.Routing; /** - Holding Pattern primary record. +Holding Pattern primary record. See section 4.1.5.1.*/ [Section('E', 'P'), Icao(11, 12), Port(7, 10), Continuous(39)] @@ -12,10 +12,8 @@ public class HoldingPattern : Record424, IIcao, INamed [Field(35, 36)] public Icao Icao { get; set; } - /** - Duplicate Indicator (DUP IND) field. - - See section 5.114.*/ + /// Duplicate Indicator (DUP IND) field. + /// See section 5.114.*/ [Field(28, 29)] public string? DuplicateIndicator { get; set; } @@ -23,10 +21,8 @@ public class HoldingPattern : Record424, IIcao, INamed [Identifier(30, 34), Icao(35, 36)] public Fix Fix { get; set; } - /** - Inbound Holding Course (IB HOLD CRS) field. - - See section 5.62.*/ + /// Inbound Holding Course (IB HOLD CRS) field. + /// See section 5.62.*/ [Field(40, 43)] public Course In { get; set; } @@ -35,17 +31,17 @@ public class HoldingPattern : Record424, IIcao, INamed public Turn Turn { get; set; } /** - Leg Length (LEG LENGTH) field. + Leg Length (LEG LENGTH) field. - Nautical miles and tenths of mile. + Nautical miles. See section 5.64.*/ [Field(45, 47), Float(10)] public float LegLength { get; set; } /** - Leg Time (LEG TIME) field. + Leg Time (LEG TIME) field. - Minutes and tenths of minute. + Minutes. See section 5.65.*/ [Field(48, 49), Float(10)] public float LegTime { get; set; } @@ -59,7 +55,7 @@ public class HoldingPattern : Record424, IIcao, INamed public Altitude Maximum { get; set; } /** - Holding Speed (HOLD SPEED) field. + Holding Speed (HOLD SPEED) field. Knots. See section 5.175.*/ diff --git a/source/library/records/routing/SpecialArea.cs b/source/library/records/routing/SpecialArea.cs index 1a862e7..d0c5870 100644 --- a/source/library/records/routing/SpecialArea.cs +++ b/source/library/records/routing/SpecialArea.cs @@ -5,7 +5,7 @@ namespace Arinc424.Routing; using Terms; /** - Special Activity Area primary record. +Special Activity Area primary record. See section 4.1.33.1.*/ [Section('E', 'S'), Continuous] @@ -19,9 +19,9 @@ public class SpecialArea : Fix, IIdentity, INamed public ActivityType Type { get; set; } /** - Special Activity Area Size field. + Special Activity Area Size field. - Nautical miles and tenths of mile. + Nautical miles. See section 5.280.*/ [Field(43, 45), Float(10)] public float Size { get; set; } @@ -34,10 +34,8 @@ public class SpecialArea : Fix, IIdentity, INamed [Character(52)] public LimitUnit UpUnit { get; set; } - /** - Special Activity Area Volume character. - - See section 5.281.*/ + /// Special Activity Area Volume character. + /// See section 5.281. [Character(53)] public char Volume { get; set; } @@ -49,10 +47,8 @@ public class SpecialArea : Fix, IIdentity, INamed [Character(57)] public Privacy Privacy { get; set; } - /** - Controlling Agency field. - - See section 5.140.*/ + /// Controlling Agency field. + /// See section 5.140. [Field(59, 83)] public string? ControllingAgency { get; set; } @@ -64,10 +60,8 @@ public class SpecialArea : Fix, IIdentity, INamed [Field(87, 93)] public Frequency Frequency { get; set; } - /** - Restrictive Airspace Name field. - - See section 5.126.*/ + /// Restrictive Airspace Name field. + /// See section 5.126. [Field(94, 123)] public string? Name { get; set; } } diff --git a/source/library/records/tables/CruiseRow.cs b/source/library/records/tables/CruiseRow.cs index 5441235..ca5d903 100644 --- a/source/library/records/tables/CruiseRow.cs +++ b/source/library/records/tables/CruiseRow.cs @@ -2,34 +2,32 @@ namespace Arinc424.Tables; -/// -/// Fields of Cruising Table. -/// -/// Used by like subsequence. +/** +Fields of Cruising Table. + +Used by like subsequence.*/ public class CruiseRow : Record424, ISequenced { [Field(9, 9), Integer] public int SeqNumber { get; set; } - /// - /// Course FROM field. - /// - /// Degrees and tenths of degree. - /// See section 5.135. + /** + Course FROM field. + + Degrees. + See section 5.135.*/ [Field(29, 32), Float(10)] public float From { get; set; } - /// - /// Course TO field. - /// - /// Degrees and tenths of degree. - /// See section 5.135. + /** + Course TO field. + + Degrees. + See section 5.135.*/ [Field(33, 36), Float(10)] public float To { get; set; } - /// - /// Magnetic/True Indicator (M/T IND) character. - /// + /// Magnetic/True Indicator (M/T IND) character. /// See section 5.165. [Character(38)] public CourseType CourseType { get; set; } diff --git a/source/library/records/tables/CruiseTable.cs b/source/library/records/tables/CruiseTable.cs index 6da8c2d..2684a23 100644 --- a/source/library/records/tables/CruiseTable.cs +++ b/source/library/records/tables/CruiseTable.cs @@ -2,10 +2,10 @@ namespace Arinc424.Tables; -/// -/// Cruising Table record sequence. -/// -/// See section 4.1.16.1. +/** +Cruising Table record sequence. + +See section 4.1.16.1.*/ [Section('T', 'C'), Identifier(7, 8)] [Pipeline>] @@ -13,9 +13,7 @@ namespace Arinc424.Tables; [DebuggerDisplay($"{{{nameof(Identifier)},nq}}")] public class CruiseTable : Record424, IIdentity { - /// - /// Cruise Table Identifier (CRSE TBL IDENT) field. - /// + /// Cruise Table Identifier (CRSE TBL IDENT) field. /// See section 5.134. [Field(7, 8)] public string Identifier { get; set; } diff --git a/source/library/records/waypoints/TerminalWaypoint.cs b/source/library/records/waypoints/TerminalWaypoint.cs index 9285f37..5b39c89 100644 --- a/source/library/records/waypoints/TerminalWaypoint.cs +++ b/source/library/records/waypoints/TerminalWaypoint.cs @@ -2,10 +2,10 @@ namespace Arinc424.Waypoints; -/// -/// Airport Waypoint and Heliport Waypoint primary record. -/// -/// See section 4.1.4.1 and 4.2.2.1. +/** +Airport Waypoint and Heliport Waypoint primary record. + +See section 4.1.4.1 and 4.2.2.1.*/ [Section('P', 'C', subsectionIndex: 13), Section('H', 'C', subsectionIndex: 13)] [Port(7, 10)] diff --git a/source/library/records/waypoints/Waypoint.cs b/source/library/records/waypoints/Waypoint.cs index 3dab184..b6d7c56 100644 --- a/source/library/records/waypoints/Waypoint.cs +++ b/source/library/records/waypoints/Waypoint.cs @@ -2,10 +2,10 @@ namespace Arinc424.Waypoints; using Terms; -/// -/// Waypoint primary record. -/// -/// See section 4.1.4.1. +/** +Waypoint primary record. + +See section 4.1.4.1.*/ [Section('E', 'A')] [Identifier(14, 18), Icao(20, 21), Continuous] @@ -33,9 +33,7 @@ public class Waypoint : Fix, INamed [Field(96, 98)] public WaypointNameFormats NameFormats { get; set; } - /// - /// Waypoint Name (NAME) field. - /// + /// Waypoint Name (NAME) field. /// See section 5.43. [Field(99, 123)] public string? Name { get; set; } diff --git a/source/library/terms/common/Course.cs b/source/library/terms/common/Course.cs index 1e87148..c198429 100644 --- a/source/library/terms/common/Course.cs +++ b/source/library/terms/common/Course.cs @@ -1,14 +1,17 @@ namespace Arinc424; -/// -/// Various courses and bearings according to the specification. -/// -/// See section 5.26, 5.28, 5.47, 5.58, 5.62 and 5.167. +/** +Various courses and bearings according to the specification. + +See section 5.26, 5.28, 5.47, 5.58, 5.62 and 5.167.*/ [Decode] [DebuggerDisplay($"{{{nameof(Value)}}}, {{{nameof(Type)}}}")] public struct Course(float value, CourseType type) { + /// Angle. + /// Degrees. public float Value { get; set; } = value; + /// public CourseType Type { get; set; } = type; }