Fix brief string

[matches/MCTX3420.git] / server / data.h

diff --git a/server/data.h b/server/data.h
index 726af5c..188f5aa 100644 (file)
--- a/server/data.h
+++ b/server/data.h
@@ -1,12 +1,12 @@
 /**
- * @file datapoint.h
- * @purpose Declaration of data handling functions; saving, loading, displaying, selecting.
+ * @file data.h
+ * @brief Declaration of data handling functions; saving, loading, displaying, selecting.
  */
 
 #ifndef _DATAPOINT_H
 #define _DATAPOINT_H
 
-#define DATA_BUFSIZ 10 // Size to use for DataPoint buffers (TODO: Optimise)
+#define DATA_BUFSIZ 10 /** Size to use for DataPoint buffers (TODO: Optimise) **/
 
 
 #include "common.h"
@@ -23,8 +23,8 @@ typedef struct
 /** Enum of output format types for DataPoints **/
 typedef enum
 {
-       JSON, // JSON data
-       TSV // Tab seperated vector
+       JSON, /** JSON data */
+       TSV /** Tab seperated vector */
 } DataFormat;
 
 /** 
@@ -34,11 +34,10 @@ typedef enum
  */
 typedef struct
 {
-       FILE * read_file; // used for reading
-       FILE * write_file; // used for writing
-       int num_points; // Number of DataPoints in the file
-       const char * filename; // Name of the file
-       pthread_mutex_t mutex; // Mutex around num_points
+       FILE * file; /** file pointer */
+       int num_points; /** Number of DataPoints in the file */
+       char * filename; /** Name of the file */
+       pthread_mutex_t mutex; /** Mutex around num_points */
 } DataFile;
 
 
@@ -50,5 +49,9 @@ extern int Data_Read(DataFile * df, DataPoint * buffer, int index, int amount);
 extern void Data_PrintByIndexes(DataFile * df, int start_index, int end_index, DataFormat format);  // Print data buffer
 extern void Data_PrintByTimes(DataFile * df, double start_time, double end_time, DataFormat format); // Print data between time values
 extern int Data_FindByTime(DataFile * df, double time_stamp, DataPoint * closest); // Find index of DataPoint with the closest timestamp to that given
+extern double Data_Calibrate(double value, double x[], double y[], int size);
+
+extern void Data_Handler(DataFile * df, FCGIValue * start, FCGIValue * end, DataFormat format, double current_time); // Helper; given FCGI params print data
+extern DataFormat Data_GetFormat(FCGIValue * fmt); // Helper; convert human readable format string to DataFormat
 
 #endif //_DATAPOINT_H