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

fixed typos and other minor things

Browse Source
This commit is contained in:
Celine Mercier
2015-06-10 15:19:02 +02:00
parent 9b6de9c411
commit 5d967f5b7b
9 changed files with 171 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/obidmscolumn.h
View File

@ -1,12 +1,12 @@
/****************************************************************************
* OBIDMSColumn header file *
* OBIDMS_column header file *
****************************************************************************/
/**
* @file obidmscolumn.h
* @author Celine Mercier
* @date 12 May 2015
* @brief Header file for the shared elements of all the OBIColumn structures.
* @brief Header file for the shared elements of all the OBIDMS column structures.
*/
#ifndef OBIDMSCOLUMN_H_
@ -34,10 +34,10 @@ typedef int32_t obiversion_t; /**< Used to store the column version number
* @brief OBIColumnHeader structure.
*/
typedef struct OBIDMSColumnHeader {
typedef struct OBIDMS_column_header {
bool little_endian; /**< endianess of the column:
- `true` on little endian platform
- `false` on big endian platform
- `true` on little endian platforms
- `false` on big endian platforms
@see obi_is_little_end()
*/
@ -52,41 +52,42 @@ typedef struct OBIDMSColumnHeader {
*/
char comments[1]; /**< comments stored as a classical
zero end C string. T
The size of the comment is just limited
The size of the comment is only limited
by the header size
*/
} OBIDMSColumnHeader_t, *OBIDMSColumnHeader_p;
} OBIDMS_column_header_t, *OBIDMS_column_header_p;
/**
* @brief Structure describing a Column of the OBITools DMS
*
* A data structure of this type is returned by the functions
* creating, opening or cloning an OBIDMSColumn.
* creating, opening or cloning an OBIDMS_column.
*/
typedef struct OBIDMSColumn {
typedef struct OBIDMS_column {
OBIDMS_p dms ; /**< A pointer to a DMS instance
*/
OBIDMSColumnHeader_p header; /**< A pointer to the header of the column
OBIDMS_column_header_p header; /**< A pointer to the header of the column
*/
void* data; /**< A `void` pointer to the beginning of the
* data.
*
* @attention never use this member directly
* outside of the code of the
* low level functions
* of the OBITools DMS
* @warning never use this member directly
* outside of the code of the
* low level functions
* of the OBITools DMS
*/
bool writable;/**< Indicates if the column is writable or not.
* - `true` the column is writable
* - `false` the column is read-only
*
* A column is writable only by its creator
* until he closes it.
* until it closes it.
*/
} OBIDMSColumn_t, *OBIDMSColumn_p;
} OBIDMS_column_t, *OBIDMS_column_p;
/**
* @brief Return the header size in bytes of a column on this platform.
* @brief Returns the header size in bytes of a column on this platform.
*
* Header size is defined as a multiple of the memory page size.
* Up to now the header size is defined as one time the page size
@ -99,27 +100,25 @@ typedef struct OBIDMSColumn {
size_t obi_get_platform_header_size();
/**
* @brief Create a column.
* @brief Creates a column.
*
* @param dms a pointer as returned by obi_create_dms() or obi_open_dms()
* @param name the name of the new column
* @param type the OBIType code used to create the column
* @param nbelement the number of element to be stored
* @param nbelements the number of elements to be stored
*
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
OBIDMSColumn_p obi_create_column(OBIDMS_p dms,
OBIDMS_column_p obi_create_column(OBIDMS_p dms,
char* name,
OBIType_t type,
size_t nbelement);
size_t nbelements);
/**
* @brief Return the latest column version in the `dms` database
* @brief Returns the latest column version in the `dms` database
*
* @param dms a pointer as returned by obi_create_dms() or obi_open_dms()
* @param name the name of the column
@ -130,5 +129,4 @@ OBIDMSColumn_p obi_create_column(OBIDMS_p dms,
obiversion_t obi_latest_version(OBIDMS_p dms,char *name);
#endif /* OBIDMSCOLUMN_H_ */