subfield.h
Go to the documentation of this file.
1 /*
2  * libasterix
3  * Copyright [2020] SinoATC (http://www.sinoatc.com/).
4  * Copyright [2013-2020] Aerosys Corporation (http://www.aerosys.cn/).
5  * All Rights Reserved.
6  *
7  * NOTICE: All information contained herein is, and remains
8  * the property of SinoATC and its suppliers, if any.
9  * The intellectual and technical concepts contained herein
10  * are proprietary to Aerosys Corporation and its suppliers and may be
11  * covered by U.S. and Foreign Patents, patents in process,
12  * and are protected by trade secret or copyright law.
13  * Dissemination of this information or reproduction of this material
14  * is strictly forbidden unless prior written permission is obtained
15  * from SinoATC.
16  */
17 
24 #ifndef LIBASTERIX_SUBFIELD_H
25 #define LIBASTERIX_SUBFIELD_H
26 
27 #include "fspec.h"
28 #include "dataitem.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
47 #define AST_MAP_SUBFIELD_TYPE_EX(category_name, category_value, dataitem, subfield) \
48  I ## category_name ## _ ## dataitem ## _ ## S ## subfield = category_value ## dataitem ## 0 ## subfield,
49 
53 typedef enum _ast_subfield_type_t
54 {
55  INULLFIELD = 0,
56 
57  //For CAT001~CAT009
58 #define AST_MAP_SUBFIELD_TYPE(category, dataitem, subfield) AST_MAP_SUBFIELD_TYPE_EX(00 ## category, category, dataitem, subfield)
59 
60  //Dataitem I004/100
61  AST_MAP_SUBFIELD_TYPE(4, 100, 01)
62  AST_MAP_SUBFIELD_TYPE(4, 100, 02)
63  AST_MAP_SUBFIELD_TYPE(4, 100, 03)
64  AST_MAP_SUBFIELD_TYPE(4, 100, 04)
65  AST_MAP_SUBFIELD_TYPE(4, 100, 05)
66  AST_MAP_SUBFIELD_TYPE(4, 100, 06)
67 
68  //Dataitem I004/120
69  AST_MAP_SUBFIELD_TYPE(4, 120, 01)
70  AST_MAP_SUBFIELD_TYPE(4, 120, 02)
71  AST_MAP_SUBFIELD_TYPE(4, 120, 03)
72  AST_MAP_SUBFIELD_TYPE(4, 120, 04)
73 
74  //Dataitem I004/170
75  AST_MAP_SUBFIELD_TYPE(4, 170, 01)
76  AST_MAP_SUBFIELD_TYPE(4, 170, 02)
77  AST_MAP_SUBFIELD_TYPE(4, 170, 03)
78  AST_MAP_SUBFIELD_TYPE(4, 170, 04)
79  AST_MAP_SUBFIELD_TYPE(4, 170, 05)
80  AST_MAP_SUBFIELD_TYPE(4, 170, 06)
81  AST_MAP_SUBFIELD_TYPE(4, 170, 07)
82  AST_MAP_SUBFIELD_TYPE(4, 170, 08)
83  AST_MAP_SUBFIELD_TYPE(4, 170, 09)
84  AST_MAP_SUBFIELD_TYPE(4, 170, 10)
85 
86  //Dataitem I004/171
87  AST_MAP_SUBFIELD_TYPE(4, 171, 01)
88  AST_MAP_SUBFIELD_TYPE(4, 171, 02)
89  AST_MAP_SUBFIELD_TYPE(4, 171, 03)
90  AST_MAP_SUBFIELD_TYPE(4, 171, 04)
91  AST_MAP_SUBFIELD_TYPE(4, 171, 05)
92  AST_MAP_SUBFIELD_TYPE(4, 171, 06)
93  AST_MAP_SUBFIELD_TYPE(4, 171, 07)
94  AST_MAP_SUBFIELD_TYPE(4, 171, 08)
95  AST_MAP_SUBFIELD_TYPE(4, 171, 09)
96  AST_MAP_SUBFIELD_TYPE(4, 171, 10)
97 
98  //For CAT010~CAT099
99 #undef AST_MAP_SUBFIELD_TYPE
100 #define AST_MAP_SUBFIELD_TYPE(category, dataitem, subfield) AST_MAP_SUBFIELD_TYPE_EX(0 ## category, category, dataitem, subfield)
101 
102  //Dataitem I021/110
103  AST_MAP_SUBFIELD_TYPE(21, 110, 01)
104  AST_MAP_SUBFIELD_TYPE(21, 110, 02)
105 
106  //Dataitem I021/220
107  AST_MAP_SUBFIELD_TYPE(21, 220, 01)
108  AST_MAP_SUBFIELD_TYPE(21, 220, 02)
109  AST_MAP_SUBFIELD_TYPE(21, 220, 03)
110  AST_MAP_SUBFIELD_TYPE(21, 220, 04)
111 
112  //Dataitem I021/295
113  AST_MAP_SUBFIELD_TYPE(21, 295, 01)
114  AST_MAP_SUBFIELD_TYPE(21, 295, 02)
115  AST_MAP_SUBFIELD_TYPE(21, 295, 03)
116  AST_MAP_SUBFIELD_TYPE(21, 295, 04)
117  AST_MAP_SUBFIELD_TYPE(21, 295, 05)
118  AST_MAP_SUBFIELD_TYPE(21, 295, 06)
119  AST_MAP_SUBFIELD_TYPE(21, 295, 07)
120  AST_MAP_SUBFIELD_TYPE(21, 295, 08)
121  AST_MAP_SUBFIELD_TYPE(21, 295, 09)
122  AST_MAP_SUBFIELD_TYPE(21, 295, 10)
123  AST_MAP_SUBFIELD_TYPE(21, 295, 11)
124  AST_MAP_SUBFIELD_TYPE(21, 295, 12)
125  AST_MAP_SUBFIELD_TYPE(21, 295, 13)
126  AST_MAP_SUBFIELD_TYPE(21, 295, 14)
127  AST_MAP_SUBFIELD_TYPE(21, 295, 15)
128  AST_MAP_SUBFIELD_TYPE(21, 295, 16)
129  AST_MAP_SUBFIELD_TYPE(21, 295, 17)
130  AST_MAP_SUBFIELD_TYPE(21, 295, 18)
131  AST_MAP_SUBFIELD_TYPE(21, 295, 19)
132  AST_MAP_SUBFIELD_TYPE(21, 295, 20)
133  AST_MAP_SUBFIELD_TYPE(21, 295, 21)
134  AST_MAP_SUBFIELD_TYPE(21, 295, 22)
135  AST_MAP_SUBFIELD_TYPE(21, 295, 23)
136 
137  //Dataitem I034/050
138  AST_MAP_SUBFIELD_TYPE(34, 050, 01)
139  AST_MAP_SUBFIELD_TYPE(34, 050, 02)
140  AST_MAP_SUBFIELD_TYPE(34, 050, 03)
141  AST_MAP_SUBFIELD_TYPE(34, 050, 04)
142  AST_MAP_SUBFIELD_TYPE(34, 050, 05)
143  AST_MAP_SUBFIELD_TYPE(34, 050, 06)
144  AST_MAP_SUBFIELD_TYPE(34, 050, 07)
145 
146  //Dataitem I034/060
147  AST_MAP_SUBFIELD_TYPE(34, 060, 01)
148  AST_MAP_SUBFIELD_TYPE(34, 060, 02)
149  AST_MAP_SUBFIELD_TYPE(34, 060, 03)
150  AST_MAP_SUBFIELD_TYPE(34, 060, 04)
151  AST_MAP_SUBFIELD_TYPE(34, 060, 05)
152  AST_MAP_SUBFIELD_TYPE(34, 060, 06)
153  AST_MAP_SUBFIELD_TYPE(34, 060, 07)
154 
155  //Dataitem I048/120
156  AST_MAP_SUBFIELD_TYPE(48, 120, 01)
157  AST_MAP_SUBFIELD_TYPE(48, 120, 02)
158 
159  //Dataitem I048/130
160  AST_MAP_SUBFIELD_TYPE(48, 130, 01)
161  AST_MAP_SUBFIELD_TYPE(48, 130, 02)
162  AST_MAP_SUBFIELD_TYPE(48, 130, 03)
163  AST_MAP_SUBFIELD_TYPE(48, 130, 04)
164  AST_MAP_SUBFIELD_TYPE(48, 130, 05)
165  AST_MAP_SUBFIELD_TYPE(48, 130, 06)
166  AST_MAP_SUBFIELD_TYPE(48, 130, 07)
167 
168  //Dataitem I062/110
169  AST_MAP_SUBFIELD_TYPE(62, 110, 01)
170  AST_MAP_SUBFIELD_TYPE(62, 110, 02)
171  AST_MAP_SUBFIELD_TYPE(62, 110, 03)
172  AST_MAP_SUBFIELD_TYPE(62, 110, 04)
173  AST_MAP_SUBFIELD_TYPE(62, 110, 05)
174  AST_MAP_SUBFIELD_TYPE(62, 110, 06)
175  AST_MAP_SUBFIELD_TYPE(62, 110, 07)
176 
177  //Dataitem I062/290
178  AST_MAP_SUBFIELD_TYPE(62, 290, 01)
179  AST_MAP_SUBFIELD_TYPE(62, 290, 02)
180  AST_MAP_SUBFIELD_TYPE(62, 290, 03)
181  AST_MAP_SUBFIELD_TYPE(62, 290, 04)
182  AST_MAP_SUBFIELD_TYPE(62, 290, 05)
183  AST_MAP_SUBFIELD_TYPE(62, 290, 06)
184  AST_MAP_SUBFIELD_TYPE(62, 290, 07)
185  AST_MAP_SUBFIELD_TYPE(62, 290, 08)
186  AST_MAP_SUBFIELD_TYPE(62, 290, 09)
187  AST_MAP_SUBFIELD_TYPE(62, 290, 10)
188 
189  //Dataitem I062/295
190  AST_MAP_SUBFIELD_TYPE(62, 295, 01)
191  AST_MAP_SUBFIELD_TYPE(62, 295, 02)
192  AST_MAP_SUBFIELD_TYPE(62, 295, 03)
193  AST_MAP_SUBFIELD_TYPE(62, 295, 04)
194  AST_MAP_SUBFIELD_TYPE(62, 295, 05)
195  AST_MAP_SUBFIELD_TYPE(62, 295, 06)
196  AST_MAP_SUBFIELD_TYPE(62, 295, 07)
197  AST_MAP_SUBFIELD_TYPE(62, 295, 08)
198  AST_MAP_SUBFIELD_TYPE(62, 295, 09)
199  AST_MAP_SUBFIELD_TYPE(62, 295, 10)
200  AST_MAP_SUBFIELD_TYPE(62, 295, 11)
201  AST_MAP_SUBFIELD_TYPE(62, 295, 12)
202  AST_MAP_SUBFIELD_TYPE(62, 295, 13)
203  AST_MAP_SUBFIELD_TYPE(62, 295, 14)
204  AST_MAP_SUBFIELD_TYPE(62, 295, 15)
205  AST_MAP_SUBFIELD_TYPE(62, 295, 16)
206  AST_MAP_SUBFIELD_TYPE(62, 295, 17)
207  AST_MAP_SUBFIELD_TYPE(62, 295, 18)
208  AST_MAP_SUBFIELD_TYPE(62, 295, 19)
209  AST_MAP_SUBFIELD_TYPE(62, 295, 20)
210  AST_MAP_SUBFIELD_TYPE(62, 295, 21)
211  AST_MAP_SUBFIELD_TYPE(62, 295, 22)
212  AST_MAP_SUBFIELD_TYPE(62, 295, 23)
213  AST_MAP_SUBFIELD_TYPE(62, 295, 24)
214  AST_MAP_SUBFIELD_TYPE(62, 295, 25)
215  AST_MAP_SUBFIELD_TYPE(62, 295, 26)
216  AST_MAP_SUBFIELD_TYPE(62, 295, 27)
217  AST_MAP_SUBFIELD_TYPE(62, 295, 28)
218  AST_MAP_SUBFIELD_TYPE(62, 295, 29)
219  AST_MAP_SUBFIELD_TYPE(62, 295, 30)
220  AST_MAP_SUBFIELD_TYPE(62, 295, 31)
221 
222  //Dataitem I062/340
223  AST_MAP_SUBFIELD_TYPE(62, 340, 01)
224  AST_MAP_SUBFIELD_TYPE(62, 340, 02)
225  AST_MAP_SUBFIELD_TYPE(62, 340, 03)
226  AST_MAP_SUBFIELD_TYPE(62, 340, 04)
227  AST_MAP_SUBFIELD_TYPE(62, 340, 05)
228  AST_MAP_SUBFIELD_TYPE(62, 340, 06)
229 
230  //Dataitem I062/380
231  AST_MAP_SUBFIELD_TYPE(62, 380, 01)
232  AST_MAP_SUBFIELD_TYPE(62, 380, 02)
233  AST_MAP_SUBFIELD_TYPE(62, 380, 03)
234  AST_MAP_SUBFIELD_TYPE(62, 380, 04)
235  AST_MAP_SUBFIELD_TYPE(62, 380, 05)
236  AST_MAP_SUBFIELD_TYPE(62, 380, 06)
237  AST_MAP_SUBFIELD_TYPE(62, 380, 07)
238  AST_MAP_SUBFIELD_TYPE(62, 380, 08)
239  AST_MAP_SUBFIELD_TYPE(62, 380, 09)
240  AST_MAP_SUBFIELD_TYPE(62, 380, 10)
241  AST_MAP_SUBFIELD_TYPE(62, 380, 11)
242  AST_MAP_SUBFIELD_TYPE(62, 380, 12)
243  AST_MAP_SUBFIELD_TYPE(62, 380, 13)
244  AST_MAP_SUBFIELD_TYPE(62, 380, 14)
245  AST_MAP_SUBFIELD_TYPE(62, 380, 15)
246  AST_MAP_SUBFIELD_TYPE(62, 380, 16)
247  AST_MAP_SUBFIELD_TYPE(62, 380, 17)
248  AST_MAP_SUBFIELD_TYPE(62, 380, 18)
249  AST_MAP_SUBFIELD_TYPE(62, 380, 19)
250  AST_MAP_SUBFIELD_TYPE(62, 380, 20)
251  AST_MAP_SUBFIELD_TYPE(62, 380, 21)
252  AST_MAP_SUBFIELD_TYPE(62, 380, 22)
253  AST_MAP_SUBFIELD_TYPE(62, 380, 23)
254  AST_MAP_SUBFIELD_TYPE(62, 380, 24)
255  AST_MAP_SUBFIELD_TYPE(62, 380, 25)
256  AST_MAP_SUBFIELD_TYPE(62, 380, 26)
257  AST_MAP_SUBFIELD_TYPE(62, 380, 27)
258  AST_MAP_SUBFIELD_TYPE(62, 380, 28)
259 
260  //Dataitem I062/390
261  AST_MAP_SUBFIELD_TYPE(62, 390, 01)
262  AST_MAP_SUBFIELD_TYPE(62, 390, 02)
263  AST_MAP_SUBFIELD_TYPE(62, 390, 03)
264  AST_MAP_SUBFIELD_TYPE(62, 390, 04)
265  AST_MAP_SUBFIELD_TYPE(62, 390, 05)
266  AST_MAP_SUBFIELD_TYPE(62, 390, 06)
267  AST_MAP_SUBFIELD_TYPE(62, 390, 07)
268  AST_MAP_SUBFIELD_TYPE(62, 390, 08)
269  AST_MAP_SUBFIELD_TYPE(62, 390, 09)
270  AST_MAP_SUBFIELD_TYPE(62, 390, 10)
271  AST_MAP_SUBFIELD_TYPE(62, 390, 11)
272  AST_MAP_SUBFIELD_TYPE(62, 390, 12)
273  AST_MAP_SUBFIELD_TYPE(62, 390, 13)
274  AST_MAP_SUBFIELD_TYPE(62, 390, 14)
275  AST_MAP_SUBFIELD_TYPE(62, 390, 15)
276  AST_MAP_SUBFIELD_TYPE(62, 390, 16)
277  AST_MAP_SUBFIELD_TYPE(62, 390, 17)
278  AST_MAP_SUBFIELD_TYPE(62, 390, 18)
279 
280  //Dataitem I062/500
281  AST_MAP_SUBFIELD_TYPE(62, 500, 01)
282  AST_MAP_SUBFIELD_TYPE(62, 500, 02)
283  AST_MAP_SUBFIELD_TYPE(62, 500, 03)
284  AST_MAP_SUBFIELD_TYPE(62, 500, 04)
285  AST_MAP_SUBFIELD_TYPE(62, 500, 05)
286  AST_MAP_SUBFIELD_TYPE(62, 500, 06)
287  AST_MAP_SUBFIELD_TYPE(62, 500, 07)
288  AST_MAP_SUBFIELD_TYPE(62, 500, 08)
289 
290 } ast_subfield_type_t;
291 
293 typedef struct _ast_subfield_t
294 {
295  bool existing;
296 
297  const unsigned char* data;
298  size_t size;
299 
300  ast_subfield_type_t type;
301 
302  bool valid;
303 } ast_subfield_t;
304 
306 #define AST_MAX_SUBFIELD_SIZE 32
307 
309 AST_API size_t ast_subfield_get_size(const unsigned char* buffer, const size_t bufsize, const ast_subfield_type_t type);
310 
312 AST_API const char* ast_subfield_get_id(const ast_subfield_type_t type);
313 
315 AST_API const char* ast_subfield_get_name(const ast_subfield_type_t type);
316 
318 #define AST_SUBFIELD_SUMMARY_PREFERED_CHARS summary_size
319 
321 AST_API void ast_subfield_get_summary(char* summary, const size_t summary_size, const ast_dataitem_t di, const ast_subfield_type_t type);
322 
324 AST_API void ast_subfield_get_detail_html(char* detail, const size_t detail_size, const ast_dataitem_t di, const ast_subfield_type_t type);
325 
327 #define AST_SUBFIELD_BIN_HTML_PREFERED_CHARS (AST_MAX_SUBFIELD_SIZE * 128 + 64)
328 
334 AST_API void ast_subfield_get_bin_html(char* html, const size_t html_size, const ast_subfield_t sf);
335 
363 #define AST_MAX_SUBFIELDS 35
364 
366 typedef struct _ast_dataitem_subfields_t
367 {
368  bool valid;
369 
370  ast_fspec_t fspec;
371  ast_subfield_t subfields[AST_MAX_SUBFIELDS];
372  size_t n_subfields;
373 } ast_dataitem_subfields_t;
374 
376 AST_API size_t ast_dataitem_subfields_get_size(const unsigned char* buffer, const size_t bufsize, const ast_dataitem_type_t dataitem);
377 
379 AST_API size_t ast_dataitem_subfields_get_number(const ast_dataitem_type_t type);
380 
382 AST_API ast_dataitem_subfields_t ast_dataitem_subfields_decode(const ast_dataitem_t di);
383 
385 AST_API void ast_dataitem_subfields_get_summary(char* summary, const size_t summary_size, const ast_dataitem_t di);
386 
388 AST_API void ast_dataitem_subfields_get_detail_html(char* detail, const size_t detail_size, const ast_dataitem_t di);
389 
393 #ifdef __cplusplus
394  }
395 #endif // extern "C"
396 
397 #endif //LIBASTERIX_SUBFIELD_H
398 
399 // vim:set ft=c sw=2 sts=2 fenc=utf8:
ast_subfield_type_t
ast_subfield_type_t
Definition of subfield id in each dataitem.
Definition: subfield.h:53
ast_subfield_t::existing
bool existing
Definition: subfield.h:295
ast_subfield_t::valid
bool valid
True if subfield is correctlly decoded.
Definition: subfield.h:302
ast_subfield_get_id
const char * ast_subfield_get_id(const ast_subfield_type_t type)
Get ID string of subfield.
ast_dataitem_subfields_t::valid
bool valid
Definition: subfield.h:368
AST_API
#define AST_API
Definition: platform.h:63
ast_dataitem_subfields_decode
ast_dataitem_subfields_t ast_dataitem_subfields_decode(const ast_dataitem_t di)
Decode function.
INULLFIELD
Null subfield.
Definition: subfield.h:55
ast_subfield_get_bin_html
void ast_subfield_get_bin_html(char *html, const size_t html_size, const ast_subfield_t sf)
Function to get a html snippet of the raw subfield data in binary format.
ast_subfield_t::type
ast_subfield_type_t type
Type of subfield.
Definition: subfield.h:300
ast_subfield_get_size
size_t ast_subfield_get_size(const unsigned char *buffer, const size_t bufsize, const ast_subfield_type_t type)
Get size of subfield.
fspec.h
Implementation of Field SPECification (FSPEC) concept defined by ASTERIX.
ast_dataitem_subfields_t::n_subfields
size_t n_subfields
Definition: subfield.h:372
AST_MAP_SUBFIELD_TYPE
#define AST_MAP_SUBFIELD_TYPE(category, dataitem, subfield)
Definition: subfield.h:100
ast_subfield_t
Subfield struct.
Definition: subfield.h:293
ast_fspec_t
Definition: fspec.h:36
dataitem.h
Implementation of Dataitem concept defined by ASTERIX.
ast_dataitem_subfields_get_size
size_t ast_dataitem_subfields_get_size(const unsigned char *buffer, const size_t bufsize, const ast_dataitem_type_t dataitem)
Get size function.
ast_subfield_get_name
const char * ast_subfield_get_name(const ast_subfield_type_t type)
Get name of subfield.
ast_dataitem_subfields_t::fspec
ast_fspec_t fspec
Definition: subfield.h:370
ast_dataitem_subfields_get_detail_html
void ast_dataitem_subfields_get_detail_html(char *detail, const size_t detail_size, const ast_dataitem_t di)
Get detail function.
ast_subfield_t::data
const unsigned char * data
Address of subfield.
Definition: subfield.h:297
ast_dataitem_t
Dataitem.
Definition: dataitem.h:421
ast_subfield_get_detail_html
void ast_subfield_get_detail_html(char *detail, const size_t detail_size, const ast_dataitem_t di, const ast_subfield_type_t type)
Get detail of subfield, in html format.
ast_subfield_t::size
size_t size
Size of subfield.
Definition: subfield.h:298
ast_dataitem_type_t
ast_dataitem_type_t
Definition of data item id in each category.
Definition: dataitem.h:67
AST_MAX_SUBFIELDS
#define AST_MAX_SUBFIELDS
Definition: subfield.h:363
ast_dataitem_subfields_get_number
size_t ast_dataitem_subfields_get_number(const ast_dataitem_type_t type)
Get number of subfields function.
ast_dataitem_subfields_get_summary
void ast_dataitem_subfields_get_summary(char *summary, const size_t summary_size, const ast_dataitem_t di)
Get summary funciton.
ast_subfield_get_summary
void ast_subfield_get_summary(char *summary, const size_t summary_size, const ast_dataitem_t di, const ast_subfield_type_t type)
Get summary of subfield.
ast_dataitem_subfields_t
Data Item - Subfields.
Definition: subfield.h:366
Copyright 2008-2020 SinoATC