Skip to content

Commit 5e22ecb

Browse files
misterrodgmisterrodg
committed
Add Object Documentation
1 parent 2bad71a commit 5e22ecb

20 files changed

+492
-0
lines changed

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,7 @@ airport = c.find_airport("KIAD")
8686
with open("output.json", "w") as json_file:
8787
json.dump(airport.to_dict(), json_file, indent=2)
8888
```
89+
90+
## CIFP Objects
91+
92+
A breakdown of the different objects can be found in the [Docs](./docs/) directory.

‎docs/CIFPAirport.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# The CIFPAirport Object
2+
3+
The CIFP airport object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- airport_id: The ICAO code of the airport.
8+
- region: The ICAO region (e.g. `K6` for NE US).
9+
- sub_code: The subsection code, used in parsing.
10+
- iata: The IATA code of the airport.
11+
- cont_rec_no: The continuation record number, used in parsing.
12+
- limit_alt: The speed limit altitude.
13+
- longest: The longest runway length.
14+
- is_ifr: An IFR capability marker.
15+
- longest_surface: The surface type of the longest runway.
16+
- lat: The airport reference point latitude.
17+
- lon: The airport reference point longitude.
18+
- mag_var: The magnetic variation.
19+
- elevation: The field elevation.
20+
- limit: The speed limit.
21+
- rec_vhf: The recommended/associated navaid.
22+
- rec_vhf_region: The region of the recommended/associated navaid.
23+
- transition_alt: The transition altitude.
24+
- transition_level: The transition level.
25+
- usage: The use type (e.g. Civilian or Military).
26+
- time_zone: The time zone.
27+
- daylight_ind: A DST marker.
28+
- mag_true: A marker for magnetic or true heading usage.
29+
- datum_code: The reference system used in surveying.
30+
- airport_name: The name of the airport.
31+
- record_number: The CIFP record number.
32+
- cycle_data: The cycle ID of when the record was added/updated.
33+
34+
Additionally, the airport object has lists of child objects:
35+
36+
- points: A list of [CIFPWaypoint](./CIFPWaypoint.md) objects.
37+
- loc_gs: A list of [CIFP_LOC_GS](./CIFP_LOC_GS.md) objects.
38+
- departures: A list of [CIFPProcedure](./CIFPProcedure.md) objects.
39+
- arrivals: A list of [CIFPProcedure](./CIFPProcedure.md) objects.
40+
- approaches: A list of [CIFPProcedure](./CIFPProcedure.md) objects.
41+
- runways: A list of [CIFPRunway](./CIFPRunway.md) objects.

‎docs/CIFPAirway.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# The CIFPAirway Object
2+
3+
The CIFP airway object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- sub_code: The subsection code, used in parsing.
8+
- airway_id: The ID of the airway.
9+
- six_char: A six character representation, if one exists.
10+
- application: The application type, used in parsing.
11+
- notes: The airway notes.
12+
13+
Additionally, the airway object has lists of child objects:
14+
15+
- points: A list[CIFPAirwayPoint](./CIFPAirwayPoint.md) objects.

‎docs/CIFPAirwayPoint.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# The CIFPAirwayPoint Object
2+
3+
The CIFP airway point object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- sub_code: The subsection code, used in parsing.
8+
- airway_id: The ID of the airway.
9+
- six_char: A six character ID if one exists.
10+
- sequence_number: The sequence number of the point in the airway.
11+
- point_id: The ID of the point along the airway.
12+
- point_region: The region of the point.
13+
- point_sec_code: The section code of the point.
14+
- point_sub_code: The subsection of the point.
15+
- description_code: The description code, used in parsing.
16+
- bound_code: The code of the boundary being crossed.
17+
- route_type: The airway type.
18+
- level: The level of the airway (high, low, or both).
19+
- direct: A one-way restriction in relation to the sequence numbers (forward or backward). Blank if none.
20+
- tc_ind: The cruise table indicator.
21+
- eu_ind: The EU indicator.
22+
- rec_vhf: The ID of the recommended navaid.
23+
- rec_vhf_region: The ICAO region of the recommended navaid.
24+
- rnp: The RNP value.
25+
- theta: The magnetic bearing to the `point_id` from the `rec_vhf`.
26+
- rho: The distance to the `point_id` from the `rec_vhf`.
27+
- out_mag_crs: The outbound magnetic course.
28+
- from_dist: The distance from this point to the next.
29+
- in_mag_crs: The inbound magnetic course.
30+
- min_alt: The minimum altitude.
31+
- min_alt_2: The second minimum altitude.
32+
- max_alt: The maximum altitude.
33+
- fix_radius: The fixed radius transition value.
34+
- sig_point: Some airways are not continuous. This identifier notes if the point is the start (`S`) or end (`E`) point for that section.
35+
- record_number: The CIFP record number.
36+
- cycle_data: The cycle ID of when the record was added/updated.

‎docs/CIFPControlledAirspace.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# The CIFPControlledAirspace Object
2+
3+
The CIFP controlled airspace object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- sub_code: The subsection code, used in parsing.
8+
- region: The ICAO region (e.g. `K6` for NE US).
9+
- airspace_type: The airspace type.
10+
- center_id: The airport ID of the center point.
11+
- center_sec_code: The section code of the center point.
12+
- center_sub_code: The subsection code of the center point.
13+
- airspace_class: The class of the airspace.
14+
- application: The application type, used in parsing.
15+
- time_code: The time code.
16+
- notam: A marker for NOTAM-controlled timing.
17+
- time_ind: The time indicator.
18+
- op_time_1: The first operating time slot.
19+
- op_time_2: The second operating time slot.
20+
- op_time_3: The third operating time slot.
21+
- op_time_4: The fourth operating time slot.
22+
- op_time_5: The fifth operating time slot.
23+
- op_time_6: The sixth operating time slot.
24+
- op_time_7: The seventh operating time slot.
25+
- controlling_agency: The controlling agency.
26+
27+
Additionally, the controlled airspace object has lists of child objects:
28+
29+
- segments: A list of [CIFPControlledAirspaceSegment](./CIFPControlledAirspaceSegment.md) objects.

‎docs/CIFPControlledAirspacePoint.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# The CIFPControlledAirspacePoint Object
2+
3+
The CIFP controlled airspace point object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- sub_code: The subsection code, used in parsing.
8+
- region: The ICAO region (e.g. `K6` for NE US).
9+
- airspace_type: The airspace type.
10+
- center_id: The airport ID of the center point.
11+
- center_sec_code: The section code of the center point.
12+
- center_sub_code: The subsection code of the center point.
13+
- airspace_class: The class of the airspace.
14+
- multiple_code: The multiple code, used in parsing.
15+
- sequence_number: The sequence number of the point in the airspace.
16+
- level: The airspace level.
17+
- time_zone: The time zone.
18+
- notam: A marker for NOTAM-controlled timing.
19+
- boundary_via: A marker showing how the boundary is defined.
20+
- lat: The latitude of the point.
21+
- lon: The longitude of the point.
22+
- arc_lat: The latitude of the arc.
23+
- arc_lon: The longitude of the arc.
24+
- arc_dist: The distance from the arc lat/lon point.
25+
- arc_bearing: The starting bearing of the arc.
26+
- rnp: The RNP value.
27+
- lower_limit: The lower limit of the airspace.
28+
- lower_unit: The unit of the lower limit.
29+
- upper_limit The upper limit of the airspace.
30+
- upper_unit: The unit of the upper limit.
31+
- airspace_name: The name of the airspace.
32+
- record_number: The CIFP record number.
33+
- cycle_data: The cycle ID of when the record was added/updated.

‎docs/CIFPControlledAirspaceSegment.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# The CIFPControlledAirspaceSegment Object
2+
3+
The CIFP controlled airspace segment object comprises the following fields:
4+
5+
- multiple_code: The multiple code, used in parsing.
6+
- airspace_name: The name of the airspace.
7+
8+
Additionally, the controlled airspace segment object has lists of child objects:
9+
10+
- points: A list of [CIFPControlledAirspacePoint](./CIFPControlledAirspacePoint.md) objects.

‎docs/CIFPHeliport.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# The CIFPHeliport Object
2+
3+
The CIFP heliport object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- heliport_id: The ICAO code of the heliport.
8+
- region: The ICAO region (e.g. `K6` for NE US).
9+
- sub_code: The subsection code, used in parsing.
10+
- iata: The IATA code of the heliport.
11+
- pad_id: The ID of the helipad (similar to a runway ID).
12+
- cont_rec_no: The continuation record number, used in parsing.
13+
- limit_alt: The speed limit altitude.
14+
- datum_code: The reference system used in surveying.
15+
- is_ifr: An IFR capability marker.
16+
- lat: The heliport reference point latitude.
17+
- lon: The heliport reference point longitude.
18+
- mag_var: The magnetic variation.
19+
- elevation: The field elevation.
20+
- limit: The speed limit.
21+
- rec_vhf: The recommended/associated navaid.
22+
- rec_vhf_region: The region of the recommended/associated navaid.
23+
- transition_alt: The transition altitude.
24+
- transition_level: The transition level.
25+
- usage: The use type (e.g. Civilian or Military).
26+
- time_zone: The time zone.
27+
- daylight_ind: A DST marker.
28+
- pad_dimensions: The dimensions of the helipad.
29+
- mag_true: A marker for magnetic or true heading usage.
30+
- heliport_name: The name of the heliport.
31+
- record_number: The CIFP record number.
32+
- cycle_data: The cycle ID of when the record was added/updated.
33+
34+
Additionally, the heliport object has lists of child objects:
35+
36+
- points: A list of [CIFPWaypoint](./CIFPWaypoint.md) objects.
37+
- departures: A list of [CIFPProcedure](./CIFPProcedure.md) objects.
38+
- arrivals: A list of [CIFPProcedure](./CIFPProcedure.md) objects.
39+
- approaches: A list of [CIFPProcedure](./CIFPProcedure.md) objects.

‎docs/CIFPProcedure.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# The CIFPProcedure Object
2+
3+
The CIFP procedure object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- procedure_id: The ID (or computer code) of the procedure.
8+
9+
Additionally, the procedure object has a list of child objects:
10+
11+
- segments: A list of [CIFPProcedureSegment](./CIFPProcedureSegment.md) objects.

‎docs/CIFPProcedurePoint.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# The CIFPProcedure point Object
2+
3+
The CIFP procedure point object comprises the following fields:
4+
5+
- area: The world region (e.g. `USA` or `CAN`).
6+
- sec_code: The section code, used in parsing.
7+
- fac_id: The ID of the associated facility (airport or heliport ID).
8+
- fac_region: The ICAO region of the associated facility.
9+
- fac_sub_code: The subsection code of the associated facility.
10+
- procedure_id: The ID (or computer code) of the associated procedure.
11+
- route_type: The route type (e.g. SID, STAR, IAP)
12+
- transition_id: The ID (or computer code) of the associated transition.
13+
- sequence_number: The sequence number of the point in the procedure.
14+
- fix_id: The ICAO code of the fix.
15+
- fix_region: The ICAO region of the fix.
16+
- fix_sec_code: The section code of the fix.
17+
- fix_sub_code: The subsection code of the fix.
18+
- description_code: The description code, used in parsing.
19+
- turn_direction: The direction of the turn.
20+
- rnp: The RNP requirement for the leg.
21+
- path_term: The path termination.
22+
- tdv: Turn direction valid marker, used in conjunction with `turn_direction`.
23+
- rec_vhf: The recommended/associated navaid.
24+
- rec_vhf_region: The region of the recommended/associated navaid.
25+
- arc_radius: The arc radius for RTF legs.
26+
- theta: The magnetic bearing to the `fix_id` from the `rec_vhf`.
27+
- rho: The distance to the `fix_id` from the `rec_vhf`.
28+
- course: The course.
29+
- dist: The distance (if a hold, the distance of the hold leg).
30+
- time: The time, if applicable (if a hold, the time of the hold leg).
31+
- rec_vhf_sec_code: The section code of the recommended/associated navaid.
32+
- rec_vhf_sub_code: The subsection code of the recommended/associated navaid.
33+
- alt_desc: The altitude descriptor.
34+
- atc: An ATC override marker.
35+
- altitude: The altitude for the leg.
36+
- flight_level: The flight level for the leg.
37+
- altitude_2: The second altitude for the leg.
38+
- flight_level_2: The second flight level for the leg.
39+
- trans_alt: The transition altitude.
40+
- speed_limit: The speed limit.
41+
- vert_angle: The vertical angle.
42+
- center_fix: The center fix for an RTF leg.
43+
- multiple_code: The multiple code, used in parsing.
44+
- center_fix_region: The center fix region.
45+
- center_fix_sec_code: The center fix section code.
46+
- center_fix_sub_code: The center fix subsection code.
47+
- gns_fms_id: The GNS/FMS ID.
48+
- speed_limit_2: The second speed limit.
49+
- rte_qual_1: The route qualifier (specifies requirements).
50+
- rte_qual_2: The second route qualifier (denotes approach types).
51+
- record_number: The CIFP record number.
52+
- cycle_data: The cycle ID of when the record was added/updated.

0 commit comments

Comments
 (0)