GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > FILE / V3-7-5
Constituent: file_swap Tag: rad750
#include "FILE/FILE_hdr_msg.h"
Include dependency graph for FILE_hdr.h:
This graph shows which files directly or indirectly include this file:
Defines | |
| #define | FILE_HDR_NAME_SIZE 8 |
Typedefs | |
| typedef enum _FILE_Hdr_Version | FILE_Hdr_Version |
| typedef enum _FILE_Hdr_Compression_Flag | FILE_Hdr_Compression_Flag |
Enumerations | |
| enum | _FILE_Hdr_Version { FILE_HDR_VERSION_1 = 0x2000, FILE_HDR_VERSION_2 = 0x4000 } |
| enum | _FILE_Hdr_Compression_Flag { FILE_HDR_UNCOMPRESSED = 0x0000, FILE_HDR_COMPRESSED = 0x1000 } |
Functions | |
| unsigned int | FILE_hdrSizeof (void) |
| Get the size of a file header. | |
| unsigned int | FILE_hdrCreate (void *buf, unsigned int length, unsigned int time, unsigned int chksum, unsigned short type, unsigned int key, FILE_Hdr_Compression_Flag compress, const char *name) |
| Create a new file header. | |
| unsigned int | FILE_hdrGetLength (const void *buf, unsigned int *length) |
| Get the file data size. | |
| unsigned int | FILE_hdrGetChksum (const void *buf, unsigned int *chksum) |
| Get the file checksum. | |
| unsigned int | FILE_hdrGetTime (const void *buf, unsigned int *time) |
| Get the file timestamp. | |
| unsigned int | FILE_hdrGetType (const void *buf, unsigned short *type) |
| Get the file type. | |
| unsigned int | FILE_hdrGetKey (const void *buf, unsigned int *key) |
| Get the file key. | |
| unsigned int | FILE_hdrGetCompression (const void *buf, unsigned short *compress) |
| Get the file compression flag. | |
| unsigned int | FILE_hdrGetName (const void *buf, char *name) |
| Get the file name string. | |
| unsigned int | FILE_hdrVerify (const void *buf) |
| Verify the integrety of a file header. | |
The functions in this library manuipulate the members of a standard LAT file object header. All of the functions work on a memory buffer; users are responsible for reading in the header from a file before queries and for writing the header to a file after modifications.
There is a function FILE_hdrCreate(), which will create a new file header in user memory from scratch. All header member values must be specified. For each of the header members, the functions FILE_hdrGetXXX() will selectively retrive values from an existing file header in user memory.
The LAT file headers contain two checksums: one for the header contents and one for the file data contents. It is up to the user to calculate and verify the checksums for the actual file data. The library functions simply treat the file data checksum as an opaque value. The library functions, however, will calculate and verify the header checksum value when appropriate. The header checksum is not exposed by any functions in this library. It is calculated using the ZLIB adler32() function. The value is set in FILE_hdrCreate() and verified in FILE_hdrVerify().
|
|
The size in bytes of the file name contained in a file header. |
|
|
The typedef for _FILE_Hdr_Compression_Flag. |
|
|
The typedef for _FILE_Hdr_Version. |
|
|
The file header compression flag values. |
|
|
The file header version values. Tracks the binary external format changes. |
1.3.3