Functions | |
| int | beatl2_ingest (int num_files, const char **filenames, const char *filter, beatl2_Record **record) |
This module contains the product ingestion functionality of BEAT-II. Although internally this is the largest module of the BEAT-II layer, on the outside it has only one function, the beatl2_ingest() function.
The internals of this module have a strong link with the BEAT-II Data Description documentation which is also part of the BEAT package. For information about which products can be ingested, what filter options can/should be provided and what kind of record data to expect from an ingestion you should look at the Data Description documentation.
| int beatl2_ingest | ( | int | num_files, |
| const char ** | filenames, | ||
| const char * | filter, | ||
| beatl2_Record ** | record | ||
| ) |
Ingest one or more files and return a BEAT-II record with the data that matches the ingestion filter. For more information about the kind of product types that are supported look at the BEAT-II Data Description documentation that came with BEAT. This documentation also explains the kind of filter options that can be passed for each type of product and what kind of BEAT-II record you can expect to have returned to you. On success this function will create a BEAT-II record and return it. This means that you are responsible to free the record again after you have used it with a call to beatl2_record_remove(). If the ingestion failed the record variable will remain unchanged.
| num_files | The number of filenames in the filenames list. |
| filenames | List of filenames of the files that need to be ingested. All files need to be of the same product type. |
| filter | String containing a ',' or ';' separated list of key=value pairs with filter options ('value' may be a space separated list of values). The filter parameter string may be set to either an empty string ("") or NULL if no filter options are required. |
| record | Pointer to the variable where the BEAT-II record will be stored when the ingestion succeeded. |
0, Success. -1, Error occurred (check beatl2_errno).