dive.h

   1 #ifndef DIVE_H
   2 #define DIVE_H
   3
   4 #include <stdlib.h>
   5 #include <time.h>
   6
   7 /*
   8  * Some silly typedefs to make our units very explicit.
   9  *
  10  * Also, the units are chosen so that values can be expressible as
  11  * integers, so that we never have FP rounding issues. And they
  12  * are small enough that converting to/from imperial units doesn't
  13  * really matter.
  14  *
  15  * We also strive to make '0' a meaningless number saying "not
  16  * initialized", since many values are things that may not have
  17  * been reported (eg tank pressure or temperature from dive
  18  * computers that don't support them). But sometimes -1 is an even
  19  * more explicit way of saying "not there".
  20  *
  21  * Thus "millibar" for pressure, for example, or "millikelvin" for
  22  * temperatures. Doing temperatures in celsius or fahrenheit would
  23  * make for loss of precision when converting from one to the other,
  24  * and using millikelvin is SI-like but also means that a temperature
  25  * of '0' is clearly just a missing temperature or tank pressure.
  26  *
  27  * Also strive to use units that can not possibly be mistaken for a
  28  * valid value in a "normal" system without conversion. If the max
  29  * depth of a dive is '20000', you probably didn't convert from mm on
  30  * output, or if the max depth gets reported as "0.2ft" it was either
  31  * a really boring dive, or there was some missing input conversion,
  32  * and a 60-ft dive got recorded as 60mm.
  33  *
  34  * Doing these as "structs containing value" means that we always
  35  * have to explicitly write out those units in order to get at the
  36  * actual value. So there is hopefully little fear of using a value
  37  * in millikelvin as Fahrenheit by mistake.
  38  *
  39  * We don't actually use these all yet, so maybe they'll change, but
  40  * I made a number of types as guidelines.
  41  */
  42 typedef struct {
  43         int seconds;
  44 } duration_t;
  45
  46 typedef struct {
  47         int mm;
  48 } depth_t;
  49
  50 typedef struct {
  51         int mbar;
  52 } pressure_t;
  53
  54 typedef struct {
  55         int mkelvin;
  56 } temperature_t;
  57
  58 typedef struct {
  59         int mliter;
  60 } volume_t;
  61
  62 typedef struct {
  63         int permille;
  64 } fraction_t;
  65
  66 typedef struct {
  67         int grams;
  68 } weight_t;
  69
  70 typedef struct {
  71         fraction_t o2;
  72         fraction_t he;
  73 } gasmix_t;
  74
  75 typedef struct {
  76         volume_t size;
  77         pressure_t pressure;
  78 } tank_type_t;
  79
  80 static inline int to_feet(depth_t depth)
  81 {
  82         return depth.mm * 0.00328084 + 0.5;
  83 }
  84
  85 static inline int to_C(temperature_t temp)
  86 {
  87         if (!temp.mkelvin)
  88                 return 0;
  89         return (temp.mkelvin - 273150) / 1000;
  90 }
  91
  92 static inline int to_PSI(pressure_t pressure)
  93 {
  94         return pressure.mbar * 0.0145037738 + 0.5;
  95 }
  96
  97 struct sample {
  98         duration_t time;
  99         depth_t depth;
 100         temperature_t temperature;
 101         pressure_t tankpressure;
 102         int tankindex;
 103 };
 104
 105 #define MAX_MIXES (4)
 106
 107 struct dive {
 108         const char *name;
 109         time_t when;
 110         char *location;
 111         char *notes;
 112         depth_t maxdepth, meandepth;
 113         duration_t duration, surfacetime;
 114         depth_t visibility;
 115         temperature_t airtemp, watertemp;
 116         pressure_t beginning_pressure, end_pressure;
 117         gasmix_t gasmix[MAX_MIXES];
 118         int samples;
 119         struct sample sample[];
 120 };
 121
 122 extern int verbose;
 123
 124 struct dive_table {
 125         int nr, allocated;
 126         struct dive **dives;
 127 };
 128
 129 extern struct dive_table dive_table;
 130
 131 static inline struct dive *get_dive(unsigned int nr)
 132 {
 133         if (nr >= dive_table.nr)
 134                 return NULL;
 135         return dive_table.dives[nr];
 136 }
 137
 138 extern void parse_xml_init(void);
 139 extern void parse_xml_file(const char *filename);
 140
 141 extern void flush_dive_info_changes(void);
 142 extern void save_dives(const char *filename);
 143
 144 static inline unsigned int dive_size(int samples)
 145 {
 146         return sizeof(struct dive) + samples*sizeof(struct sample);
 147 }
 148
 149 extern struct dive *fixup_dive(struct dive *dive);
 150 extern struct dive *try_to_merge(struct dive *a, struct dive *b);
 151
 152 #endif /* DIVE_H */