BDS

Data Structures

struct  ast_bds_t
 Binary Data Source (BDS) More...
 

Macros

#define AST_MAP_BDS_TYPE(msb, lsb)   BDS ## msb ## lsb = 0x ## msb ## lsb,
 Macro used to map BDS type. More...
 
#define AST_MAX_BDS   8
 Max number of BDS in one data item. More...
 
#define AST_BDS_SIZE   7
 BDS bytes. More...
 
#define AST_BDS_DETAIL_HTML_PREFERED_CHARS   20480
 Prefered number of chars of BDS detail description HTML snippet. More...
 

Enumerations

enum  ast_bds_type_t {
  BDS00 = 0x00, BDS10 = 0x10, BDS17 = 0x17, BDS20 = 0x20,
  BDS30 = 0x30, BDS40 = 0x40, BDS50 = 0x50, BDS60 = 0x60,
  BDSE1 = 0xE1
}
 Definition of BDS type. More...
 

Functions

const char * ast_bds_type_to_str (const ast_bds_type_t type)
 Convert from ast_bds_type_t to C string. More...
 
const char * ast_bds_type_to_str_simple (const ast_bds_type_t type)
 Convert from ast_bds_type_t to C string simple version. More...
 
ast_bds_t ast_bds_decode (const unsigned char *buffer, const size_t bufsize, const ast_bds_type_t type)
 Decode BDS from binary data. More...
 
const char * ast_bds_get_name (const ast_bds_type_t type)
 Function to get name of one BDS. More...
 
void ast_bds_get_detail_html (char *detail, const size_t detail_size, const ast_bds_t bds)
 Function to get a html snippet of detailed description of dataitem. More...
 
void ast_bds_get_detail_html_dummy (char *detail, const size_t detail_size, const ast_bds_t bds)
 Dummy get detail function. More...
 

Detailed Description

Macro Definition Documentation

◆ AST_BDS_DETAIL_HTML_PREFERED_CHARS

#define AST_BDS_DETAIL_HTML_PREFERED_CHARS   20480

Prefered number of chars of BDS detail description HTML snippet.

◆ AST_BDS_SIZE

#define AST_BDS_SIZE   7

BDS bytes.

◆ AST_MAP_BDS_TYPE

#define AST_MAP_BDS_TYPE (   msb,
  lsb 
)    BDS ## msb ## lsb = 0x ## msb ## lsb,

Macro used to map BDS type.

A BDS type is an enum value like BDS40, and it's value will be 0x40.

◆ AST_MAX_BDS

#define AST_MAX_BDS   8

Max number of BDS in one data item.

Enumeration Type Documentation

◆ ast_bds_type_t

Definition of BDS type.

Enumerator
BDS00 

Null (Invalid) BDS.

BDS10 
BDS17 
BDS20 
BDS30 
BDS40 
BDS50 
BDS60 
BDSE1 

Function Documentation

◆ ast_bds_decode()

ast_bds_t ast_bds_decode ( const unsigned char *  buffer,
const size_t  bufsize,
const ast_bds_type_t  type 
)

Decode BDS from binary data.

◆ ast_bds_get_detail_html()

void ast_bds_get_detail_html ( char *  detail,
const size_t  detail_size,
const ast_bds_t  bds 
)

Function to get a html snippet of detailed description of dataitem.

Parameters
detailBuffer to save the html snippet
detail_sizeBuffer size
bdsBDS

The returned html fragment contains only basic elements used in html body, such as <br/> <h> <table>....

This function will return only semantics markups, some elements will cantaion class name, and it's recomanded the libary user to use CSS to format the html style.

◆ ast_bds_get_detail_html_dummy()

void ast_bds_get_detail_html_dummy ( char *  detail,
const size_t  detail_size,
const ast_bds_t  bds 
)

Dummy get detail function.

For some data items, it's not necesary to implement a get_detail_html function. In this case, the dataitem's get_detail_html_func can be register to this dummy function. It' will only set detail as a NULL string and do nothing else.

◆ ast_bds_get_name()

const char* ast_bds_get_name ( const ast_bds_type_t  type)

Function to get name of one BDS.

Name is the title of each BDS defined in RTCA documentation

◆ ast_bds_type_to_str()

const char* ast_bds_type_to_str ( const ast_bds_type_t  type)

Convert from ast_bds_type_t to C string.

Returns
string like "BDS4,0";

◆ ast_bds_type_to_str_simple()

const char* ast_bds_type_to_str_simple ( const ast_bds_type_t  type)

Convert from ast_bds_type_t to C string simple version.

Returns
string like "4,0";