Functions and files for OBIDMS columns with the type OBI_FLOAT
This commit is contained in:
59
src/obidmscolumn_float.h
Normal file
59
src/obidmscolumn_float.h
Normal file
@ -0,0 +1,59 @@
|
||||
/****************************************************************************
|
||||
* OBIDMS_column_float header file *
|
||||
****************************************************************************/
|
||||
|
||||
/**
|
||||
* @file obidsmcolumn_float.h
|
||||
* @author Celine Mercier
|
||||
* @date August 10th 2015
|
||||
* @brief Header file for the functions handling OBIColumns containing data with the OBIType OBI_FLOAT.
|
||||
*/
|
||||
|
||||
|
||||
#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_FLOAT.
|
||||
*
|
||||
* @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_float(OBIDMS_column_p column, size_t line_nb, size_t element_idx, obifloat_t value);
|
||||
|
||||
|
||||
/**
|
||||
* @brief Recovers a value in an OBIDMS column containing data with the type OBI_FLOAT.
|
||||
*
|
||||
* @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)
|
||||
*/
|
||||
obifloat_t obi_column_get_float(OBIDMS_column_p column, size_t line_nb, size_t element_idx);
|
||||
|
||||
|
Reference in New Issue
Block a user