YBOS decode library


The format used inside the farm package is based on YBOS. This format is composed of several banks and inside the banks there are the real data. The YBOS decode library was created to extract that data.

Index:


Supported banks

The supported banks are:


Initialization

In order to use the YBOS decode library, you must first initialize it with farm_yboslocateinit_. Of course, once you finish using it, you should cleanup with farm_yboslocatedone_.

Follows the description of the two functions:

farm_yboslocateinit_()
Initialize the YBOS decode library.

Syntax:
int farm_yboslocateinit_(int *ybospointer );
Parameters:
IN: ybospointer
Pointer to the YBOS data.
Returns:
0 in case of success

farm_yboslocatedone_()
Dispose the previously initialized library.

Syntax:
int farm_yboslocatedone_(int *ybospointer );
Parameters:
IN: ybospointer
Pointer to the YBOS data. (Must be the same as with farm_yboslocateinit_)
Returns:
0 in case of success


Extract the data

To extract the real data from the YBOS data, use
farm_yboslocate_():
Syntax:
int farm_yboslocate_(int *ybospointer, char*bankname, int *nwords, int **indat_pointer);
Parameters:
IN: ybospointer
Pointer to the YBOS data. (Must be the same as with farm_yboslocateinit_)
IN: bankname
The name of the bank
OUT: nwords
The size of the real data in words (4 bytes)
OUT: indat_pointer
Pointer to the real data (Inside the YBOS data, DO NOT DISPOSE IT)
Returns:
0 in case of success

Top of the page. Farm documentation.
Send comments to: Stefano Miscetti or Igor Sfiligoi

Created:22.9.1997
Last modified:22.9.1997