Functions to get obiblobs through views

This commit is contained in:
Celine Mercier
2016-11-18 15:59:50 +01:00
parent 7d022c1a52
commit 621b4972db
4 changed files with 88 additions and 5 deletions

View File

@ -26,6 +26,7 @@
#include "obidmscolumn.h"
#include "obierrno.h"
#include "hashtable.h"
#include "obiblob.h"
#define OBIVIEW_NAME_MAX_LENGTH (249) /**< The maximum length of an OBIDMS view name, without the extension.
@ -490,6 +491,48 @@ int obi_close_view(Obiview_p view);
int obi_save_and_close_view(Obiview_p view);
/**
* @brief Recovers an obiblob from an OBIDMS column containing indices referring to obiblobs, in the context of a view.
*
* @param view A pointer on the opened view.
* @param column_p A pointer on the 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.
*
* @returns The recovered obiblob.
* @retval OBIBlob_NA the NA value of the type if an error occurred and obi_errno is set.
*
* @since November 2016
* @author Celine Mercier (celine.mercier@metabarcoding.org)
*/
Obi_blob_p obi_get_blob_with_elt_idx_and_col_p_in_view(Obiview_p view, OBIDMS_column_p column_p, index_t line_nb, index_t element_idx);
// TODO
Obi_blob_p obi_get_blob_with_elt_idx_and_col_name_in_view(Obiview_p view, const char* column_name, index_t line_nb, index_t element_idx);
/**
* @brief Recovers an obiblob from an OBIDMS column containing indices referring to obiblobs,
* using the name of the element in the line, in the context of a view.
*
* @param view A pointer on the opened view.
* @param column_p A pointer on the column.
* @param line_nb The number of the line where the value should be recovered.
* @param element_name The name of the element that should be recovered in the line.
*
* @returns The recovered obiblob.
* @retval OBIBlob_NA the NA value of the type if an error occurred and obi_errno is set.
*
* @since November 2016
* @author Celine Mercier (celine.mercier@metabarcoding.org)
*/
Obi_blob_p obi_get_blob_with_elt_name_and_col_p_in_view(Obiview_p view, OBIDMS_column_p column_p, index_t line_nb, const char* element_name);
// TODO
Obi_blob_p obi_get_blob_with_elt_name_and_col_name_in_view(Obiview_p view, const char* column_name, index_t line_nb, const char* element_name);
/**
* @brief Sets a value in an OBIDMS column containing data with the type OBI_BOOL, using the index of the element in the line,
* in the context of a view.