GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > FILE / V3-8-0
Constituent: file_hdr_boot     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. |
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. |
|
Create a new file header. Creates a file header in the buffer specified by buf. The user is resposible for actually writing the new header into file storage. This library only supports buffers whose total size is aligned on a 16-bit boundary. The function will fail with error #FILE_EHDRPARM if the length parameter is not correctly aligned.
|
|
Get the file checksum. Returns the checksum of the remainder of the file header and file data.
|
|
Get the file compression flag. Returns the file compression flag value.
|
|
Get the file key. Returns the file key value.
|
|
Get the file data size. Returns the size in bytes of file data following the file header.
|
|
Get the file name string. Returns the file name string. The ASCII characters are copied to the user buffer indicated by name. The string is not NULL terminated after return.
|
|
Get the file timestamp. Returns the file timestamp.
|
|
Get the file type. Returns the file type code.
|
|
Get the size of a file header. Returns the size in bytes of a LAT file header.
|
|
Verify the integrety of a file header. Verifies the format of a file header in buf. Calculates header checksum and compares it to value stored in header.
|