Files and functions for OBIDMS columns with the data type OBI_BOOL

src/obidmscolumn_bool.c

@@ -0,0 +1,41 @@
+/****************************************************************************
+ * OBIDMS_column_bool functions                                              *
+ ****************************************************************************/
+
+/**
+ * @file obidsmcolumn_bool.c
+ * @author Celine Mercier
+ * @date August 10th 2015
+ * @brief Functions handling OBIColumns containing data with the OBIType OBI_BOOL.
+ */
+
+
+#include <stdlib.h>
+#include <stdio.h>
+
+#include "obidmscolumn.h"
+#include "obitypes.h"
+#include "obierrno.h"
+#include "obidebug.h"
+
+
+/**********************************************************************
+ *
+ * D E F I N I T I O N   O F   T H E   P U B L I C   F U N C T I O N S
+ *
+ **********************************************************************/
+
+int obi_column_set_bool(OBIDMS_column_p column, size_t line_nb, size_t element_idx, obibool_t value)
+{
+	// when/where check if can write?
+	// check if value in enum?
+	*(((obibool_t*) (column->data)) + (line_nb * ((column->header)->nb_elements_per_line)) + element_idx) = value;
+	return 0;
+}
+
+
+obibool_t obi_column_get_bool(OBIDMS_column_p column, size_t line_nb, size_t element_idx)
+{
+	return *(((obibool_t*) (column->data)) + (line_nb * ((column->header)->nb_elements_per_line)) + element_idx);
+}
+

src/obidmscolumn_bool.h

@@ -0,0 +1,59 @@
+/****************************************************************************
+ * OBIDMS_column_bool header file                                            *
+ ****************************************************************************/
+
+/**
+ * @file obidsmcolumn_bool.h
+ * @author Celine Mercier
+ * @date August 10th 2015
+ * @brief Header file for the functions handling OBIColumns containing data with the OBIType OBI_BOOL.
+ */
+
+
+#include <stdlib.h>
+#include <stdio.h>
+
+#include "obidmscolumn.h"
+#include "obitypes.h"
+
+
+/**
+ * @brief Sets a value in an OBIDMS column containing data with the type OBI_BOOL.
+ *
+ * @param column a pointer as returned by obi_create_column()
+ * @warning Pointers returned by obi_open_column() don't allow writing.
+ *
+ * @param line_nb the number of the line where the value should be set
+ *
+ * @param element_idx the index of the element that should be set in the line
+ *
+ * @param value the value that should be set
+ *
+ * @return an integer value indicating the success of the operation.
+ *
+ * @retvalue 0 on success
+ * @retvalue -1 on failure and the `obi_errno` variable is set.
+ *
+ * @since August 2015
+ * @author Celine Mercier (celine.mercier@metabarcoding.org)
+ */
+int obi_column_set_bool(OBIDMS_column_p column, size_t line_nb, size_t element_idx, obibool_t value);
+
+
+/**
+ * @brief Recovers a value in an OBIDMS column containing data with the type OBI_BOOL.
+ *
+ * @param column a pointer as returned by obi_create_column()
+ *
+ * @param line_nb the number of the line where the value should be recovered
+ *
+ * @param element_idx the index of the element that should be recovered in the line
+ *
+ * @return the recovered value
+ *
+ * @since August 2015
+ * @author Celine Mercier (celine.mercier@metabarcoding.org)
+ */
+obibool_t obi_column_get_bool(OBIDMS_column_p column, size_t line_nb, size_t element_idx);
+
+

src/obitypes.c

@@ -30,6 +30,9 @@ size_t obi_sizeof(OBIType_t type)
 	case OBI_FLOAT: size = sizeof(obifloat_t);
 					break;
 
+	case OBI_BOOL:  size = sizeof(obibool_t);
+					break;
+
 	case OBI_CHAR:  size = sizeof(obichar_t);
 					break;
 
@@ -77,6 +80,9 @@ char* name_data_type(int data_type)
 		case OBI_FLOAT: name = strdup("OBI_FLOAT");
 						break;
 
+		case OBI_BOOL:  name = strdup("OBI_BOOL");
+						break;
+
 		case OBI_CHAR:  name = strdup("OBI_CHAR");
 						break;
 

src/obitypes.h

@@ -21,11 +21,11 @@
 /**
  * @brief enum for the boolean OBIType.
  */
-typedef enum {
+typedef enum OBIBool {
     FALSE      = 0,
     TRUE       = 1,
     OBIBool_NA = 2
-} OBIBool_t, *OBIBool_p; 		/**< a boolean true/false value */
+} obibool_t, *obibool_p; 		/**< a boolean true/false value */
 
 
 /**
@@ -35,6 +35,7 @@ typedef enum OBIType {
 	OBI_VOID    = 0,     		/**< data type not specified */
 	OBI_INT,			    	/**< a signed integer value (C type : int32_t) */
 	OBI_FLOAT,					/**< a floating value (C type : double) */
+	OBI_BOOL,					/**< a boolean true/false value, see obibool_t enum */
 	OBI_CHAR,					/**< a character (C type : char) */
 	OBI_IDX					    /**< an index in a data structure (C type : size_t) */
 } OBIType_t, *OBIType_p;