obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

Standardized and improved the API to create new columns, updated the doc

Browse Source
This commit is contained in:
Celine Mercier
2017-07-18 17:34:32 +02:00
parent c88df2e12c
commit 59dd0a8a8c
4 changed files with 47 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/obidmscolumn.h
View File

@ -196,16 +196,16 @@ size_t obi_get_platform_header_size();
* @param dms A pointer on an OBIDMS.
* @param column_name The name of the new column.
* @param data_type The OBIType code of the data.
* @param nb_lines The number of lines to be stored.
* @param nb_elements_per_line The number of elements per line. // TODO talk about default values
* @param nb_lines The number of lines to be stored (can be 0 if not known).
* @param nb_elements_per_line The number of elements per line.
* @param elements_names The names of the elements with ';' as separator (no terminal ';'),
* NULL or "" if the default names are to be used ("0\01\02\0...\0n").
* @param elt_names_formatted Whether the separator for the elements names is ';' (false), or '\0' (true, as formatted by format_elements_names()).
* @param indexer_name The name of the indexer if there is one associated with the column.
* If NULL or "", the indexer name is set as the column name.
* @param associated_column_name The name of the associated column if there is one.
* @param associated_column_version The version of the associated column if there is one.
* @param comments Optional comments associated with the column.
* @param elt_names_formatted Whether the separator for the elements names is ';' (false), or '\0' (true, as formatted by format_elements_names()).
* @param associated_column_name The name of the associated column if there is one (otherwise NULL or "").
* @param associated_column_version The version of the associated column if there is one (otherwise -1).
* @param comments Optional comments associated with the column (NULL or "" if no comments associated).
*
* @returns A pointer on the newly created column structure.
* @retval NULL if an error occurred.
@ -219,11 +219,11 @@ OBIDMS_column_p obi_create_column(OBIDMS_p dms,
index_t nb_lines,
index_t nb_elements_per_line,
char* elements_names,
bool elt_names_formatted,
const char* indexer_name,
const char* associated_column_name,
obiversion_t associated_column_version,
const char* comments,
bool elt_names_formatted
const char* comments
);