]> git.tdb.fi Git - ext/subsurface.git/blob - dive.h
Label the temperature graph
[ext/subsurface.git] / dive.h
1 #ifndef DIVE_H
2 #define DIVE_H
3
4 #include <stdlib.h>
5 #include <time.h>
6
7 #include <glib.h>
8
9 /*
10  * Some silly typedefs to make our units very explicit.
11  *
12  * Also, the units are chosen so that values can be expressible as
13  * integers, so that we never have FP rounding issues. And they
14  * are small enough that converting to/from imperial units doesn't
15  * really matter.
16  *
17  * We also strive to make '0' a meaningless number saying "not
18  * initialized", since many values are things that may not have
19  * been reported (eg cylinder pressure or temperature from dive
20  * computers that don't support them). But sometimes -1 is an even
21  * more explicit way of saying "not there".
22  *
23  * Thus "millibar" for pressure, for example, or "millikelvin" for
24  * temperatures. Doing temperatures in celsius or fahrenheit would
25  * make for loss of precision when converting from one to the other,
26  * and using millikelvin is SI-like but also means that a temperature
27  * of '0' is clearly just a missing temperature or cylinder pressure.
28  *
29  * Also strive to use units that can not possibly be mistaken for a
30  * valid value in a "normal" system without conversion. If the max
31  * depth of a dive is '20000', you probably didn't convert from mm on
32  * output, or if the max depth gets reported as "0.2ft" it was either
33  * a really boring dive, or there was some missing input conversion,
34  * and a 60-ft dive got recorded as 60mm.
35  *
36  * Doing these as "structs containing value" means that we always
37  * have to explicitly write out those units in order to get at the
38  * actual value. So there is hopefully little fear of using a value
39  * in millikelvin as Fahrenheit by mistake.
40  *
41  * We don't actually use these all yet, so maybe they'll change, but
42  * I made a number of types as guidelines.
43  */
44 typedef struct {
45         int seconds;
46 } duration_t;
47
48 typedef struct {
49         int mm;
50 } depth_t;
51
52 typedef struct {
53         int mbar;
54 } pressure_t;
55
56 typedef struct {
57         int mkelvin;
58 } temperature_t;
59
60 typedef struct {
61         int mliter;
62 } volume_t;
63
64 typedef struct {
65         int permille;
66 } fraction_t;
67
68 typedef struct {
69         int grams;
70 } weight_t;
71
72 struct gasmix {
73         fraction_t o2;
74         fraction_t he;
75 };
76
77 typedef struct {
78         volume_t size;
79         pressure_t workingpressure;
80         const char *description;        /* "LP85", "AL72", "AL80", "HP100+" or whatever */
81 } cylinder_type_t;
82
83 typedef struct {
84         cylinder_type_t type;
85         struct gasmix gasmix;
86         pressure_t start, end;
87 } cylinder_t;
88
89 static inline int to_feet(depth_t depth)
90 {
91         return depth.mm * 0.00328084 + 0.5;
92 }
93
94 static inline int to_C(temperature_t temp)
95 {
96         if (!temp.mkelvin)
97                 return 0;
98         return (temp.mkelvin - 273150 + 499) / 1000;
99 }
100
101 static inline int to_F(temperature_t temp)
102 {
103         if (!temp.mkelvin)
104                 return 0;
105         return temp.mkelvin * 9 / 5000.0 - 459.670 + 0.5;
106 }
107
108 static inline int to_K(temperature_t temp)
109 {
110         if (!temp.mkelvin)
111                 return 0;
112         return (temp.mkelvin + 499)/1000;
113 }
114
115 static inline int to_PSI(pressure_t pressure)
116 {
117         return pressure.mbar * 0.0145037738 + 0.5;
118 }
119
120 struct sample {
121         duration_t time;
122         depth_t depth;
123         temperature_t temperature;
124         pressure_t cylinderpressure;
125         int cylinderindex;
126 };
127
128 #define MAX_CYLINDERS (8)
129
130 struct dive {
131         int number;
132         time_t when;
133         char *location;
134         char *notes;
135         depth_t maxdepth, meandepth;
136         duration_t duration, surfacetime;
137         depth_t visibility;
138         temperature_t airtemp, watertemp;
139         cylinder_t cylinder[MAX_CYLINDERS];
140         int samples, alloc_samples;
141         struct sample sample[];
142 };
143
144 /*
145  * We keep our internal data in well-specified units, but
146  * the input and output may come in some random format. This
147  * keeps track of those units.
148  */
149 struct units {
150         enum { METERS, FEET } length;
151         enum { LITER, CUFT } volume;
152         enum { BAR, PSI, PASCAL } pressure;
153         enum { CELSIUS, FAHRENHEIT, KELVIN } temperature;
154         enum { KG, LBS } weight;
155 };
156
157 extern const struct units SI_units, IMPERIAL_units;
158 extern struct units input_units, output_units;
159
160 extern int verbose;
161
162 struct dive_table {
163         int nr, allocated;
164         struct dive **dives;
165 };
166
167 extern struct dive_table dive_table;
168
169 extern int selected_dive;
170 #define current_dive (get_dive(selected_dive))
171
172 static inline struct dive *get_dive(unsigned int nr)
173 {
174         if (nr >= dive_table.nr)
175                 return NULL;
176         return dive_table.dives[nr];
177 }
178
179 extern void parse_xml_init(void);
180 extern void parse_xml_file(const char *filename, GError **error);
181
182 extern void show_dive_info(struct dive *);
183 extern void flush_dive_info_changes(struct dive *);
184
185 extern void show_dive_equipment(struct dive *);
186 extern void flush_dive_equipment_changes(struct dive *);
187
188 extern void update_dive(struct dive *new_dive);
189 extern void save_dives(const char *filename);
190
191 static inline unsigned int dive_size(int samples)
192 {
193         return sizeof(struct dive) + samples*sizeof(struct sample);
194 }
195
196 extern time_t utc_mktime(struct tm *tm);
197
198 extern struct dive *alloc_dive(void);
199 extern void record_dive(struct dive *dive);
200
201 extern struct sample *prepare_sample(struct dive **divep);
202 extern void finish_sample(struct dive *dive, struct sample *sample);
203
204 extern void report_dives(void);
205 extern struct dive *fixup_dive(struct dive *dive);
206 extern struct dive *try_to_merge(struct dive *a, struct dive *b);
207
208 #define DIVE_ERROR_PARSE 1
209
210 #endif /* DIVE_H */