Main Page   Modules   File List   Globals  

Functions
BEAT-II Export/Import

Functions

int beatl2_export (const char *format, const char *filename, const beatl2_Record *record)
int beatl2_import (const char *format, const char *filename, beatl2_Record **record)

Detailed Description

The BEAT-II Export/Import module consists of only two functions (beatl2_import() and beatl2_export()) which can be used to import/export BEAT-II records to/from various data formats such as ASCII and HDF.


Function Documentation

int beatl2_export ( const char *  format,
const char *  filename,
const beatl2_Record record 
)

Export a BEAT-II record into one of the supported export formats to a file. The currently supported export formats include "ASCII", "BINARY", "NETCDF", "HFD4", and "HDF5". For a description of these export formats look at the documentation of the beatl2dump tool that is included with the BEAT package. Note that for ASCII and BINARY you can use filename=NULL to export to stdout.

Parameters:
formatString value of the name of the export format.
filenameFilename of the export file that needs to be created.
recordPointer to a valid BEAT-II record.
Returns:
int beatl2_import ( const char *  format,
const char *  filename,
beatl2_Record **  record 
)

Import a BEAT-II record from a file that was stored in one of the supported import formats. The currently supported import formats include "ASCII", "BINARY", "NETCDF", "HFD4", and "HDF5". For a description of these import formats look at the documentation of the beatl2dump tool that is included with the BEAT package.

Parameters:
formatString value of the name of the import format.
filenameFilename of the file from which the record should be imported.
recordPointer to the variable where a pointer to the imported BEAT-II record will be stored.
Returns: