ldas-tools-framecpp  2.7.0
Classes | Macros | Typedefs | Enumerations | Functions
FrDetector.h File Reference
#include "ldastoolsal/ldas_types.h"
#include "framecppc/FrameC.h"
#include "framecppc/Stream.h"
Include dependency graph for FrDetector.h:
This graph shows which files directly or indirectly include this file:

Classes

struct  fr_detector_prefix_t
 Channel prefix for this detecor. More...
 

Macros

#define DETECTOR_PREFIX_LEN   2
 

Typedefs

typedef const char * fr_detector_name_t
 Instrument name. More...
 
typedef REAL_8 fr_detector_latitude_t
 latitude as used in the fr_detector structure. More...
 
typedef REAL_8 fr_detector_longitude_t
 longitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_elevation_t
 elevation as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_azimuth_t
 x axis azimuth as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_azimuth_t
 y axis azimuth as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_altitude_t
 x axis altitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_altitude_t
 y axis altitude as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_x_midpoint_t
 x axis midpoint as used in the fr_detector structure. More...
 
typedef REAL_4 fr_detector_arm_y_midpoint_t
 y axis midpoint as used in the fr_detector structure. More...
 
typedef INT_4S fr_detector_localtime_t
 local seasonal time as used in the fr_detector structure. More...
 
typedef enum fr_detector_fields_ fr_detector_fields
 Field specifiers for querying the table of contents. More...
 
typedef struct fr_detector fr_detector_t
 

Enumerations

enum  fr_detector_fields_ {
  FR_DETECTOR_FIELD_LAST, FR_DETECTOR_FIELD_NAME, FR_DETECTOR_FIELD_PREFIX, FR_DETECTOR_FIELD_LONGITUDE,
  FR_DETECTOR_FIELD_LATITUDE, FR_DETECTOR_FIELD_ELEVATION, FR_DETECTOR_FIELD_ARM_X_AZIMUTH, FR_DETECTOR_FIELD_ARM_Y_AZIMUTH,
  FR_DETECTOR_FIELD_ARM_X_ALTITUDE, FR_DETECTOR_FIELD_ARM_Y_ALTITUDE, FR_DETECTOR_FIELD_ARM_X_MIDPOINT, FR_DETECTOR_FIELD_ARM_Y_MIDPOINT,
  FR_DETECTOR_FIELD_LOCAL_TIME, FR_DETECTOR_FIELD_LAST, FR_DETECTOR_FIELD_NAME, FR_DETECTOR_FIELD_PREFIX,
  FR_DETECTOR_FIELD_LONGITUDE, FR_DETECTOR_FIELD_LATITUDE, FR_DETECTOR_FIELD_ELEVATION, FR_DETECTOR_FIELD_ARM_X_AZIMUTH,
  FR_DETECTOR_FIELD_ARM_Y_AZIMUTH, FR_DETECTOR_FIELD_ARM_X_ALTITUDE, FR_DETECTOR_FIELD_ARM_Y_ALTITUDE, FR_DETECTOR_FIELD_ARM_X_MIDPOINT,
  FR_DETECTOR_FIELD_ARM_Y_MIDPOINT, FR_DETECTOR_FIELD_LOCAL_TIME
}
 Field specifiers for querying the table of contents. More...
 
enum  std_detectors {
  DETECTOR_LOCATION_H1, DETECTOR_LOCATION_H2, DETECTOR_LOCATION_L1, DETECTOR_LOCATION_V1,
  DETECTOR_LOCATION_H1, DETECTOR_LOCATION_H2, DETECTOR_LOCATION_L1, DETECTOR_LOCATION_V1
}
 Standard detectors. More...
 

Functions

fr_detector_tFrameCFrDetectorAlloc (FrameCError **Error, const char *restrict name, const char *restrict prefix, fr_detector_latitude_t latitude, fr_detector_longitude_t longitude, fr_detector_elevation_t elevation, fr_detector_arm_x_azimuth_t azimuth_x, fr_detector_arm_y_azimuth_t azimuth_y, fr_detector_arm_x_altitude_t altitude_x, fr_detector_arm_y_altitude_t altitude_y, fr_detector_arm_x_midpoint_t midpoint_x, fr_detector_arm_y_midpoint_t midpoint_y, fr_detector_localtime_t localtime)
 Allocate a new Detector structure. More...
 
void FrameCFrDetectorFree (FrameCError **Error, fr_detector_t *detector)
 Recyle the detector structure. More...
 
void FrameCFrDetectorQuery (FrameCError **Error, const fr_detector_t *Detector, int Option,...)
 Retrieve vector information related to the Table of Contents. More...
 
fr_detector_tFrameCFrDetectorRead (FrameCError **Error, fr_file_t *restrict Stream, const char *restrict Name)
 Read a new Detector structure. More...
 
int FrameCFrDetectorWrite (FrameCError **Error, fr_file_t *restrict Stream, const fr_detector_t *restrict Detector)
 Write a Detector structure to the stream. More...
 
fr_detector_tFrameCGetDetector (FrameCError **Error, std_detectors Type, const gpstime_t *restrict Time)
 Retrieve information about some standard detectors. More...
 

Macro Definition Documentation

◆ DETECTOR_PREFIX_LEN

#define DETECTOR_PREFIX_LEN   2