airportdb.h

Go to the documentation of this file.

/*
 * CDDL HEADER START
 *
 * This file and its contents are supplied under the terms of the
 * Common Development and Distribution License ("CDDL"), version 1.0.
 * You may only use this file in accordance with the terms of version
 * 1.0 of the CDDL.
 *
 * A full copy of the text of the CDDL should have accompanied this
 * source.  A copy of the CDDL is also available via the Internet at
 * http://www.illumos.org/license/CDDL.
 *
 * CDDL HEADER END
 *
 * Copyright 2023 Saso Kiselkov. All rights reserved.
 */
#ifndef _AIRPORTDB_H_
#define _AIRPORTDB_H_
 
#include "avl.h"
#include "geom.h"
#include "list.h"
#include "helpers.h"
#include "htbl.h"
#include "thread.h"
 
#ifdef  __cplusplus
extern "C" {
#endif
 
typedef struct {
    bool_t      inited;
    bool_t      ifr_only;
    bool_t      normalize_gate_names;
    bool_t      override_settings;
    char        *xpdir;
    char        *cachedir;
    int     xp_airac_cycle;
    double      load_limit;
 
    mutex_t     lock;
 
    avl_tree_t  apt_dat;
    avl_tree_t  geo_table;
    avl_tree_t  arpt_index;
    htbl2_t     icao_index;
    htbl2_t     iata_index;
} airportdb_t;
 
typedef struct airport airport_t;
typedef struct runway runway_t;
typedef struct runway_end runway_end_t;
 
typedef enum {
    RAMP_START_GATE,
    RAMP_START_HANGAR,
    RAMP_START_TIEDOWN,
    RAMP_START_MISC
} ramp_start_type_t;
 
typedef struct ramp_start {
    char            name[32];   
    geo_pos2_t      pos;        
    float           hdgt;       
    ramp_start_type_t   type;       
    avl_node_t      node;
} ramp_start_t;
 
typedef enum {
    RWY_SURF_ASPHALT = 1,
    RWY_SURF_CONCRETE = 2,
    RWY_SURF_GRASS = 3,
    RWY_SURF_DIRT = 4,
    RWY_SURF_GRAVEL = 5,
    RWY_SURF_DRY_LAKEBED = 12,
    RWY_SURF_WATER = 13,
    RWY_SURF_SNOWICE = 14,
    RWY_SURF_TRANSPARENT = 15
} rwy_surf_t;
 
struct runway_end {
    char        id[4];  
    geo_pos3_t  thr;    
    geo_pos3_t  thr_m;  
    double      displ;  
    double      blast;  
    double      gpa;    
    double      tch;    
    double      tch_m;  
    /* computed on load_airport */
    vect2_t     thr_v;  
    vect2_t     dthr_v; 
    double      hdg;    
    vect2_t     *apch_bbox; 
    double      land_len; 
};
 
struct runway {
    airport_t   *arpt;      
    double      width;      
    runway_end_t    ends[2];    
    char        joint_id[8];    
    char        rev_joint_id[8];
    rwy_surf_t  surf;       
    /* computed on load_airport */
    double      length;     
    vect2_t     *prox_bbox; 
    vect2_t     *rwy_bbox;  
    vect2_t     *tora_bbox; 
    vect2_t     *asda_bbox; 
    avl_node_t  node;
};
 
typedef enum {
    FREQ_TYPE_REC,  
    FREQ_TYPE_CTAF, 
    FREQ_TYPE_CLNC, 
    FREQ_TYPE_GND,  
    FREQ_TYPE_TWR,  
    FREQ_TYPE_APP,  
    FREQ_TYPE_DEP   
} freq_type_t;
 
typedef struct {
    freq_type_t type;       
    uint64_t    freq;       
    char        name[32];   
    list_node_t node;
} freq_info_t;
 
#define AIRPORTDB_IDENT_LEN 8
#define AIRPORTDB_ICAO_LEN  8
#define AIRPORTDB_IATA_LEN  4
#define AIRPORTDB_CC_LEN    4
 
struct airport {
    char        ident[AIRPORTDB_IDENT_LEN];
    char        icao[AIRPORTDB_ICAO_LEN];
    char        iata[AIRPORTDB_IATA_LEN];
    char        cc[AIRPORTDB_CC_LEN];
    char        cc3[AIRPORTDB_CC_LEN];
    char        name[24];   
    char        *name_orig; 
    char        *country;   
    char        *city;      
    geo_pos3_t  refpt;      
    geo_pos3_t  refpt_m;    
    bool_t      geo_linked; 
    double      TA;     
    double      TL;     
    double      TA_m;       
    double      TL_m;       
    avl_tree_t  rwys;       
    avl_tree_t  ramp_starts;    
    list_t      freqs;      
    bool_t      load_complete;  
    vect3_t     ecef;       
    fpp_t       fpp;        
    bool_t      in_navdb;   
    bool_t      have_iaps;  
    avl_node_t  apt_dat_node;   
    list_node_t cur_arpts_node; 
    avl_node_t  tile_node;  
};
 
typedef struct {
    char        ident[AIRPORTDB_IDENT_LEN];
    char        icao[AIRPORTDB_ICAO_LEN];
    char        iata[AIRPORTDB_IATA_LEN];
    char        cc[AIRPORTDB_CC_LEN];
    geo_pos3_32_t   pos;    
    uint16_t    max_rwy_len; 
    uint16_t    TA; 
    uint16_t    TL; 
    avl_node_t  node;
} arpt_index_t;
 
API_EXPORT void airportdb_create(airportdb_t *db, const char *xpdir,
    const char *cachedir);
API_EXPORT void airportdb_destroy(airportdb_t *db);
 
API_EXPORT void airportdb_lock(airportdb_t *db);
API_EXPORT void airportdb_unlock(airportdb_t *db);
 
/*
 * !!!! CAREFUL !!!!
 * This function needs to use setlocale, which means it's not thread-safe.
 * You should only call this on the main thread.
 */
#define recreate_cache(__db)    adb_recreate_cache((__db), 0)
API_EXPORT bool_t adb_recreate_cache(airportdb_t *db, int app_version);
 
#define find_nearest_airports       adb_find_nearest_airports
API_EXPORT list_t *adb_find_nearest_airports(airportdb_t *db,
    geo_pos2_t my_pos);
 
#define free_nearest_airport_list   adb_free_nearest_airport_list
API_EXPORT void adb_free_nearest_airport_list(list_t *l);
 
#define set_airport_load_limit      adb_set_airport_load_limit
API_EXPORT void adb_set_airport_load_limit(airportdb_t *db, double limit);
 
#define load_nearest_airport_tiles  adb_load_nearest_airport_tiles
API_EXPORT void adb_load_nearest_airport_tiles(airportdb_t *db,
    geo_pos2_t my_pos);
 
/*
 * Query functions to look for airports
 */
#define unload_distant_airport_tiles    adb_unload_distant_airport_tiles
API_EXPORT void adb_unload_distant_airport_tiles(airportdb_t *db,
    geo_pos2_t my_pos);
 
#define airport_lookup  adb_airport_lookup
API_EXPORT airport_t *adb_airport_lookup(airportdb_t *db, const char *icao,
    geo_pos2_t pos);
 
#define airport_lookup_global   adb_airport_lookup_global
API_EXPORT airport_t *adb_airport_lookup_global(airportdb_t *db,
    const char *icao);
 
#define airport_lookup_by_ident adb_airport_lookup_by_ident
API_EXPORT airport_t *adb_airport_lookup_by_ident(airportdb_t *db,
    const char *ident);
 
#define airport_lookup_by_icao  adb_airport_lookup_by_icao
API_EXPORT size_t adb_airport_lookup_by_icao(airportdb_t *db, const char *icao,
    void (*found_cb)(airport_t *airport, void *userinfo), void *userinfo);
 
#define airport_lookup_by_iata  adb_airport_lookup_by_iata
API_EXPORT size_t adb_airport_lookup_by_iata(airportdb_t *db, const char *iata,
    void (*found_cb)(airport_t *airport, void *userinfo), void *userinfo);
 
#define airport_index_walk  adb_airport_index_walk
API_EXPORT size_t adb_airport_index_walk(const airportdb_t *db,
    void (*found_cb)(const arpt_index_t *idx, void *userinfo), void *userinfo);
/*
 * Querying information about a particular airport.
 */
#define airport_find_runway adb_airport_find_runway
API_EXPORT bool_t adb_airport_find_runway(airport_t *arpt, const char *rwy_id,
    runway_t **rwy_p, unsigned *end_p);
 
#define matching_airport_in_tile_with_TATL \
    adb_matching_airport_in_tile_with_TATL
API_EXPORT airport_t *adb_matching_airport_in_tile_with_TATL(airportdb_t *db,
    geo_pos2_t pos, const char *search_icao);
 
#define airportdb_xp11_airac_cycle  adb_airportdb_xp_airac_cycle
API_EXPORT bool_t adb_airportdb_xp_airac_cycle(const char *xpdir, int *cycle);
 
#ifdef  __cplusplus
}
#endif
 
#endif  /* _AIRPORTDB_H_ */