GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > SIIS / V0-0-1

Constituent: siis_rec_dump     Tag: sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  

SIIS_rec.h File Reference

SIIS Archive File Record Format Library Interface. More...

#include "SIIS/SIIS_msg.h"

Include dependency graph for SIIS_rec.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Data Structures

struct  _SIIS_Rec_File_Info
 SIIS archive file 'file information' record information. More...

struct  _SIIS_Rec_Hdr
 SIIS archive file record header information. More...

struct  _SIIS_Rec_Raw_Telem
 SIIS archive file 'raw telemetry' record information. More...


Defines

#define SIIS_REC_HDR_LENGTH   13
 Length of a SIIS archive file record header, in bytes.

#define SIIS_REC_TRL_LENGTH   4
 Length of a SIIS archive file record trailer, in bytes.


Typedefs

typedef _SIIS_Rec_Hdr SIIS_Rec_Hdr
typedef _SIIS_Rec_File_Info SIIS_Rec_File_Info
typedef _SIIS_Rec_Raw_Telem SIIS_Rec_Raw_Telem

Enumerations

enum  SIIS_Rec_Type {
  SIIS_REC_TYPE_RAW_TELEM,
  SIIS_REC_TYPE_FILE_INFO,
  SIIS_REC_TYPE_UNKNOWN
}
 Recognized SIIS archive file record types. More...

Detailed Description

SIIS Archive File Record Format Library Interface. 

  CVS $Id: SIIS_rec.h,v 1.1.1.1 2004/12/01 20:57:10 dmay Exp $

This library contains functions and definitions for processing SIIS archive file records.

Typedef Documentation

SIIS_Rec_File_Info
 

The typedef for _SIIS_Rec_File_Info.

SIIS_Rec_Hdr
 

The typedef for _SIIS_Rec_Hdr.

SIIS_Rec_Raw_Telem
 

The typedef for _SIIS_Rec_Raw_Telem.

Enumeration Type Documentation

enum SIIS_Rec_Type
 

Recognized SIIS archive file record types.

List of all SIIS archive file record types recognized by the SIIS_rec library.

Enumeration values:
SIIS_REC_TYPE_RAW_TELEM  Raw telemetry record.
SIIS_REC_TYPE_FILE_INFO  File information record.
SIIS_REC_TYPE_UNKNOWN  Unrecognized record.

Function Documentation

unsigned int SIIS_recGetFileInfo (  const unsigned char *  body_buf,
const unsigned int  body_buf_bytes,
SIIS_Rec_File_Info *  file_info
) 
 

Get the information found within a SIIS file information record.

Build a SIIS_Rec_File_Info structure from the information found within a SIIS archive file 'file information' record.

Parameters:
body_buf Pointer to buffer containing the record body.
body_buf_bytes Length of record body buffer, in bytes
file_info Pointer to structure to return file information.
Returns:
A SIIS MSG value.

unsigned int SIIS_recGetHdr (  const unsigned char *  hdr_buf,
const unsigned int  hdr_buf_bytes,
SIIS_Rec_Hdr *  hdr_info
) 
 

Get the information found within a SIIS record header.

Build a SIIS_Rec_Hdr structure from the information found within a SIIS archive file record header.

Parameters:
hdr_buf Pointer to buffer containing the record header.
hdr_buf_bytes Length of header buffer, in bytes
hdr_info Pointer to structure to return header information.
Returns:
A SIIS MSG value.

unsigned int SIIS_recGetRawTelem (  const unsigned char *  body_buf,
const unsigned int  body_buf_bytes,
SIIS_Rec_Raw_Telem *  raw_telem
) 
 

Get the information found within a SIIS raw telemetry record.

Build a SIIS_Rec_Raw_Telem structure from the information found within a SIIS archive file 'raw telemetry' record.

Parameters:
body_buf Pointer to buffer containing the record body.
body_buf_bytes Length of record body buffer, in bytes
raw_telem Pointer to structure to return raw telemetry info.
Returns:
A SIIS MSG value.

Generated on Thu Dec 2 02:45:46 2004 by doxygen 1.3.3