ArincDataSet Class
A dataset for reading navigation database files on the ARINC SPECIFICATION 424-16, 424-17 and 424-18 formats.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEDataSets assembly)
Syntax
public class ArincDataSet : FileDataSet,
ISearchableRemarks
This dataset reads navigation database files on the ARINC SPECIFICATION 424-16, 424-17 and 424-18 formats. It currently reads most, but not all, of the sections available in the files. The following list shows which sections are supported:
Airports
Heliports
Airport runways
Airport gates
Enroute and terminal waypoints
VHF navaids
NDB enroute and terminal navaids
Holding patterns
Enroute airways with legs
SIDs, STARs and Approach procedures
Preferred routes
FIRs and UIRs
Controlled airspaces
Restrictive airspaces
GridMORA
Airport communication (available as extended information for airports)
Heliport communication (available as extended information for heliports)
Enroute communication (available as extended information for FIRs and UIRs)
Airway restrictions (available as extended information for enroute airways)
The last four sections do not generate any features, instead the information from these sections is available during runtime through the GetExtendedInformation method.
ARINC files can be very large (> 100MB), and reading such large files can be slow. To increase performance, the ArincDataSet creates an index of the file the first time it is read. The index can be quickly searched for objects within a certain geographic area, and the objects can then be quickly read from the original file, once the reader knows where they are located in the file. When the index has been created, it is saved to disk, at the location specified by the FeatureIndexPath property. The next time the dataset is loaded, the index file is read instead of building a new index. Creation of the index the first time may take a few minutes for a large file.
The following table shows which types of features are created, which attributes the features may have, and also if they have extended information. All the attributes are set from corresponding fields in the ARINC records. Length values are converted to meters, altitudes are left as is. All objects also have the type attribute set to a unique symbol value, and a cycle attribute.
ARINC object type | Geometry type | Type attribute | Additional attributes | Description | Extended info |
|---|---|---|---|---|---|
Airport | Point | airport | id, icao, iata, name, magnetic_variation, longest_rwy, recommended_navaid, recommended_navaid_icao, category, cycle | An airport reference point. | Airport communications |
Heliport | Point | heliport | id, icao, iata, pad, name, magnetic_variation, recommended_navaid, recommended_navaid_icao, cycle | A heliport reference point. The pad attribute specifies the helipad. For heliports with more than one pad, multiple features will be created. | Heliport communications |
Airport runway | Polygon | runway | id, airport_id, airport_icao, name, length, width, bearing, cycle | In the ARINC file, the runway is specified as a point. From this point and the length, width and bearing attributes, a polygon with four corners is calculated. | None |
Airport gate | Point | gate | id, airport_id, airport_icao, name, cycle | An airport gate. | None |
Enroute waypoint | Point | enroute_waypoint | id, icao, name, waypoint_type, waypoint_usage, magnetic_variation, name_format_indicator, cycle | An enroute waypoint. | None |
Terminal waypoint | Point | terminal_waypoint | id, icao, airport_id, airport_icao, name, waypoint_type, waypoint_usage, magnetic_variation, name_format_indicator, cycle | A terminal waypoint. | None |
VHF navaid | Point | vhf | id, icao, airport_id, airport_icao, name, navaid_class, is_dme, dme_ident, frequency, elevation, cycle | A VHF navaid. | None |
Enroute NDB navaid | Point | enroute_ndb | id, icao, name, navaid_class, frequency, magnetic_variation, cycle | An enroute NDB navaid. | None |
Terminal NDB navaid | Point | terminal_ndb | id, icao, airport_id, airport_icao, name, navaid_class, frequency, magnetic_variation, cycle | An airport NDB navaid. | None |
Holding pattern | Line | holding_pattern | airport_id, airport_icao, name, cycle | A holding pattern. | Fix identifier, course, distance, speed, arc radius, altitudes etc. |
Enroute airway | Line | airway | id, route_type, customer_area_code | An airway. | List of all segments of the airway, with fix names, directions, altitudes etc, plus all defined restrictions for the airway. |
Enroute airway leg | Line | airway_leg | id, route_type, customer_area_code, leg_index, description_code, route_type, level, direction, theta, rho, outbound_course, outbound_course_true, distance, inbound_course, inbound_course_true, minalt1, minalt2, maxalt, fix, fix_icao, fix_section, cruising_table, recommended_navaid, recommended_navaid_icao, cycle | A leg of an airway. The attributes inbound_course_true and outbound_course_true denote if the course bearings are true (as opposed to magnetic). | None |
SID | Line | sid | id, airport_id, airport_icao, transition, route_type, customer_area_code | A SID, Standard Instrument Departure. Note that the different path and termination values are not supported, the SID is just a simple line feature built from the departure runway and the named fixes. | List of all segments of the SID, with fix names, altitudes, path and termination etc. |
STAR | Line | star | id, airport_id, airport_icao, transition, route_type, customer_area_code | A STAR, Standard Terminal Arrival Route. Note that the different path and termination values are not supported, the STAR is just a simple line feature built from the named fixes and the arrival runway. | List of all segments of the STAR, with fix names, altitudes, path and termination etc. |
Approach procedure | Line | approach_procedure | id, airport_id, airport_icao, transition, route_type, customer_area_code | An approach procedure. Note that the different path and termination values are not supported, the procedure is just a simple line feature built from the named fixes. | List of all segments of the procedure, with fix names, altitudes, path and termination etc. |
Preferred route | Line | pref_route | id, route_type | An airway. | List of all segments of the airway, with fix names, airway names, altitudes etc. |
FIR and UIR | Polygon | fir | id, address, name, fir_uir, fir_upper, fir_upper_numeric, uir_lower, uir_lower_numeric, uir_upper, uir_upper_numeric, cycle | An Flight Information Region or Upper Information Region. The fir_uir attribute indicates if it is a FIR, UIR or both. The numeric attributes are added as meter converted values. | Enroute communications |
Controlled airspace | Polygon | cont_airspace | id, icao, section, name, airspace_type, classification, multiple_code, lower_limit, lower_limit_numeric, lower_limit_unit, upper_limit, upper_limit_numeric, upper_limit_unit, cycle | A controlled airspace. The airspace_type attribute indicates the type of controlled airspace. The numeric attributes are added as meter converted values. The limit_unit is not used in this calculation which means that you may have to add the elevation manually. | Vertical limits, notam, Time of operation |
Restrictive airspace | Polygon | rest_airspace | id, icao, name, airspace_type, multiple_code, lower_limit, lower_limit_numeric, lower_limit_unit, upper_limit, upper_limit_numeric, upper_limit_unit, cycle | A restrictive airspace. The airspace_type attribute indicates the type of restrictive airspace. The numeric attributes are added as meter converted values. The limit_unit is not used in this calculation which means that you may have to add the elevation manually. | Vertical limits, notam, time of operation |
Grid/MORA | Polygon | mora | mora, cycle | A grid of 1 by 1 degree rectangles with a MORA (Minimum Off Route Altitude) value. Each rectangle is returned as a separate polygon feature, with the MORA value (in meters) as an attribute. | None |
The type attribute can be used for filtering out uninteresting object types and thereby increase performance, see the ArincQuery class.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
FileDataSet
ArincDataSet
Platforms
Windows, Linux, Android
ArincDataSet Members
The ArincDataSet type has the following members.
Constructors
| Name | Description |
|---|---|
| ArincDataSet | Initializes a new instance of the ArincDataSet class with the given path and filename. |
Properties
| Name | Description |
|---|---|
| Description | Gets or sets a short description of the dataset. Inherited from DataSet |
| DisplayName | Gets or sets a display name for the dataset. Inherited from DataSet |
| FeatureIndexPath | Gets or sets the directory where the feature index file will be saved. |
| FileName | Gets or sets the name of the file to read from. Inherited from FileDataSet |
| ISearchable.HasSearchIndex | Gets a value that tells whether a dataset has a search index. Inherited from ISearchable |
| Id | Gets a unique identifier for this dataset instance. Inherited from DataSet |
| IndexFileName | Gets or sets an explicit index file name used for the generated index files in IndexPath. |
| IndexPath | Gets or sets the directory where the dataset index files are saved. |
| IsDisposed | Gets a value that tells whether the current ArincDataSet has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the dataset. Inherited from DataSet |
| Name | Gets or sets the name of the ArincDataSet. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current ArincDataSet represents. Inherited from EngineObject |
| Path | Gets or sets the path to the file or files to read from. Inherited from FileDataSet |
| SearchableAttributes | The attributes that will be used to create a search index for the dataset. |
| SearchableCondition | Gets or sets a condition that determines which features will be included in the search index for the dataset. |
| SuppressInitializationErrors | Gets or sets a flag indicating how errors during dataset initialization are handled. Inherited from DataSet |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from DataSet |
| FlushCache | Frees any information the dataset may have cached, including all cached features. Inherited from DataSet |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from DataSet |
| GetDataCoverage | Gets coverage information for this dataset in a given area. Inherited from DataSet |
 GetDataSetById | Looks up an existing dataset instance from a dataset identity. Inherited from DataSet |
| GetDataSetInfo | Returns a dataset info that describes the contents of this dataset. Inherited from DataSet |
| GetDataSetInfoAsync | Makes an asynchronous call to GetDataSetInfo. Inherited from DataSet |
| GetExtendedInformation | Get extended information about a feature. |
| GetFeature | Gets the feature with the specified identity. Inherited from DataSet |
| GetFeatures | Overloaded. Gets features from the dataset. Inherited from DataSet |
| GetFloatValueAt | Overloaded. Gets the float raster value from a cell at the specified position. Inherited from DataSet |
| GetFloatValuesAt | Overloaded. Gets a number of float raster values. Inherited from DataSet |
| GetLocalizedDescription | Gets a localized version of the dataset description in a specific language. Inherited from DataSet |
| GetLocalizedDisplayName | Gets a localized version of the dataset display name in a specific language. Inherited from DataSet |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from DataSet |
| GetNormalizedFloatValueAt | Overloaded. Gets the raster value from a cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| GetNormalizedFloatValuesAt | Overloaded. Gets a number of raster values, normalized by Scale and Offset. Inherited from DataSet |
| GetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |
| GetValuesAt | Overloaded. Gets a number of raster values. Inherited from DataSet |
| HasLocalizedDescription | Checks if a localized version of the dataset description is available in a specific language. Inherited from DataSet |
| HasLocalizedDisplayName | Checks if a localized version of the dataset display name is available in a specific language. Inherited from DataSet |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from DataSet |
| HighestRasterValue | Finds the highest raster value inside the given polygon. Inherited from DataSet |
| Initialize | Initializes the dataset. Inherited from DataSet |
| ISearchable.Search | Overloaded. Searches for features with an attribute whose value match the specified search text. Inherited from ISearchable |
| SetLocalizedDescription | Sets a dataset description in a specific language. Inherited from DataSet |
| SetLocalizedDisplayName | Sets a dataset display name in a specific language. Inherited from DataSet |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the dataset, for a specific language. Inherited from DataSet |
| TryGetFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position. Inherited from DataSet |
| TryGetNormalizedFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| TryGetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |