ldas-tools-framecpp  2.6.4
Typedefs | Enumerations | Functions
FrameH.h File Reference
#include "ldastoolsal/ldas_types.h"
#include "framecppc/FrameC.h"
#include "framecppc/Stream.h"
#include "framecppc/FrChan.h"
#include "framecppc/FrDetector.h"
#include "framecppc/FrEvent.h"
#include "framecppc/FrHistory.h"
#include "framecppc/FrVect.h"

Typedefs

typedef const char * frame_h_name_t
 
typedef INT_4S frame_h_run_t
 
typedef INT_4U frame_h_frame_t
 
typedef INT_4U frame_h_data_quality_t
 
typedef gpstime_t frame_h_gtime_t
 
typedef INT_2U frame_h_uleaps_t
 
typedef REAL_8 frame_h_dt_t
 
typedef INT_2U frame_h_offset_t
 
typedef struct frame_h frame_h_t
 
typedef enum frame_h_fields_ frame_h_fields
 Field specifiers for querying the table of contents. More...
 

Enumerations

enum  frame_h_fields_ {
  FRAME_H_FIELD_LAST, FRAME_H_FIELD_NAME, FRAME_H_FIELD_RUN, FRAME_H_FIELD_FRAME,
  FRAME_H_FIELD_DATA_QUALITY, FRAME_H_FIELD_GTIME, FRAME_H_FIELD_ULEAPS, FRAME_H_FIELD_DT
}
 Field specifiers for querying the table of contents. More...
 

Functions

frame_h_tFrameCFrameHAlloc (FrameCError **Error, const char *Name, frame_h_gtime_t Start, frame_h_dt_t Dt, frame_h_frame_t FrameNumber)
 Allocate a fr_frame structure. More...
 
int FrameCFrameHFrChanAdd (FrameCError **Error, frame_h_t *Frame, fr_chan_t *Channel)
 Add a channel to the frame. More...
 
int FrameCFrameHFrDetectorAdd (FrameCError **Error, frame_h_t *Frame, fr_detector_t *Detector)
 Add a detector to the frame. More...
 
int FrameCFrameHFree (FrameCError **Error, frame_h_t *frame)
 
int FrameCFrameHFrEventAdd (FrameCError **Error, frame_h_t *Frame, fr_event_t *Event)
 Add an event to the frame. More...
 
int FrameCFrameHFrHistoryAdd (FrameCError **Error, frame_h_t *Frame, fr_history_t *History)
 Add history to the frame. More...
 
frame_h_tFrameCFrameHRead (FrameCError **Error, fr_file_t *restrict Stream, frame_h_offset_t Pos)
 Read a FrameH structure from the file. More...
 
frame_h_tFrameCFrameHReadNext (FrameCError **Error, fr_file_t *restrict Stream)
 Read a FrameH structure from the file. More...
 
void FrameCFrameHQuery (FrameCError **Error, const frame_h_t *Frame, int Option,...)
 Retrieve vector information related to the Table of Contents. More...
 
void FrameCFrameHSet (FrameCError **Error, const frame_h_t *Frame, int Option,...)
 Set values for the FrameH structure. More...
 
int FrameCFrameHWrite (FrameCError **Error, fr_file_t *restrict stream, frame_h_t *restrict frame)
 Write the frame to the stream. More...
 
int FrameCFrameHWriteCompressed (FrameCError **Error, fr_file_t *restrict stream, frame_h_t *restrict frame, fr_vect_compression_schemes_t compression, fr_vect_compression_level_t level)
 Write the frame to the stream. More...