diff options
author | Magnus Lundborg <lundborg.magnus@gmail.com> | 2014-06-22 14:24:43 (GMT) |
---|---|---|
committer | Mark Abraham <mark.j.abraham@gmail.com> | 2014-06-26 14:27:36 (GMT) |
commit | ba9aea42b01c0563e0ff0a886999daeaf6b570a7 (patch) | |
tree | 15a21fa116e7103fc097b928bae56a3e5260250d /include | |
parent | e8fa7bf3abfc74acf60a048cdfe1f65fdbc0dc2d (diff) |
Version 1.6 of the TNG library.
Added functions to get the version of the header and the
library.
Improved version control of the library using CMake config and
version files.
Changed tng_util_frame_current_compression_get() return type
to double before the API is widely circulated (no release
has been made since that function was added).
Compiling compression functions into the tng_io library.
Uses BuildTNG.cmake instead of including add_subdirectories.
Change-Id: I5e4818736fb2632c06ca7df8e84ce9544bf2acaf
Diffstat (limited to 'include')
-rw-r--r-- | include/tng/md5.h (renamed from include/md5.h) | 0 | ||||
-rw-r--r-- | include/tng/tng_io.h (renamed from include/tng_io.h) | 73 | ||||
-rw-r--r-- | include/tng/tng_io.hpp (renamed from include/tng_io.hpp) | 0 | ||||
-rw-r--r-- | include/tng/tng_io_fwd.h (renamed from include/tng_io_fwd.h) | 0 | ||||
-rw-r--r-- | include/tng/version.h.in | 16 | ||||
-rw-r--r-- | include/version.h.in | 7 |
6 files changed, 84 insertions, 12 deletions
diff --git a/include/md5.h b/include/tng/md5.h index 80fbf6c..80fbf6c 100644 --- a/include/md5.h +++ b/include/tng/md5.h diff --git a/include/tng_io.h b/include/tng/tng_io.h index 5b89cd6..42119a5 100644 --- a/include/tng_io.h +++ b/include/tng/tng_io.h @@ -21,9 +21,9 @@ * Each block can contain MD5 hashes to verify data integrity and the file * can be signed by the user to ensure that the origin is correct. * - * This is version 1.4 of the TNG API. The intention is that this version of - * the API and ABI should be stable, but it is still possible that future - * changes might make that impossible, in which case that will be clarified. + * The intention is that the API and ABI should be stable, but it is + * still possible that future changes might make that impossible, in which + * case that will be clarified. * * The API and all examples are released without any warranties. Use them at * your own risk. @@ -76,6 +76,16 @@ * * Revisions * + * v. 1.6 - Fourth stable release of the API. + * + * - Removed OpenMP option when building. + * - Functionality for migrating data blocks. + * - Improved handling of molecules. + * - Improved installation of TNG documentation. + * - Enhancements to CMake usage. + * - Required CMake version raised to 2.8.8. + * - Bugs fixed. + * * v. 1.5 - Third stable release of the API. * * - Fortran wrapper split into separate file @@ -173,7 +183,7 @@ * \code * #include <stdlib.h> * #include <stdio.h> - * #include "tng_io.h" + * #include "tng/tng_io.h" * * int main(int argc, char **argv) * { @@ -531,6 +541,59 @@ extern "C" */ /** + * @brief Get the major version of the TNG library. + * @param tng_data is a trajectory data container, it does not have + * to be initialized beforehand. + * @param version is pointing to a value set to the major version of + * the library. + * @return TNG_SUCCESS (0) if successful. + */ +tng_function_status DECLSPECDLLEXPORT tng_version_major + (const tng_trajectory_t tng_data, + int *version); + +/** + * @brief Get the minor version of the TNG library. + * @param tng_data is a trajectory data container, it does not have + * to be initialized beforehand. + * @param version is pointing to a value set to the minor version of + * the library. + * @return TNG_SUCCESS (0) if successful. + */ +tng_function_status DECLSPECDLLEXPORT tng_version_minor + (const tng_trajectory_t tng_data, + int *version); + +/** + * @brief Get the patch level of the TNG library. + * @param tng_data is a trajectory data container, it does not have + * to be initialized beforehand. + * @param patch_level is the string to fill with the full version, + * memory must be allocated before. + * @return TNG_SUCCESS (0) if successful. + */ +tng_function_status DECLSPECDLLEXPORT tng_version_patchlevel + (const tng_trajectory_t tng_data, + int *patch_level); + +/** + * @brief Get the full version string of the TNG library. + * @param tng_data is a trajectory data container, it does not have + * to be initialized beforehand. + * @param version is pointing to a value set to the major version of + * the library. + * @param max_len maximum char length of the string, i.e. how much memory has + * been reserved for version. This includes \0 terminating character. + * @pre \code version != 0 \endcode The pointer to the name string + * must not be a NULL pointer. + * @return TNG_SUCCESS (0) if successful. + */ +tng_function_status DECLSPECDLLEXPORT tng_version + (const tng_trajectory_t tng_data, + char *version, + const int max_len); + +/** * @brief Setup a trajectory data container. * @param tng_data_p a pointer to memory to initialise as a trajectory. * @pre tng_data_p must not be pointing at a reserved memory block. @@ -4677,7 +4740,7 @@ tng_function_status DECLSPECDLLEXPORT tng_util_frame_current_compression_get (tng_trajectory_t tng_data, const int64_t block_id, int64_t *codec_id, - float *factor); + double *factor); /** @brief High-level function for determining the next frame with data and what * data blocks have data for that frame. The search can be limited to certain diff --git a/include/tng_io.hpp b/include/tng/tng_io.hpp index 12172e5..12172e5 100644 --- a/include/tng_io.hpp +++ b/include/tng/tng_io.hpp diff --git a/include/tng_io_fwd.h b/include/tng/tng_io_fwd.h index 8b63a9a..8b63a9a 100644 --- a/include/tng_io_fwd.h +++ b/include/tng/tng_io_fwd.h diff --git a/include/tng/version.h.in b/include/tng/version.h.in new file mode 100644 index 0000000..662e68f --- /dev/null +++ b/include/tng/version.h.in @@ -0,0 +1,16 @@ +#ifndef VERSION_CONFIG_H +#define VERSION_CONFIG_H + +/* define the API version (integer) */ +#define TNG_API_VERSION @TNG_API_VERSION@ + +/* define the major and minor versions + of the library */ +#define TNG_VERSION_MAJOR @TNG_MAJOR_VERSION@ +#define TNG_VERSION_MINOR @TNG_MINOR_VERSION@ +/* define the patchlevel of the library */ +#define TNG_VERSION_PATCHLEVEL @TNG_VERSION_PATCH_LEVEL@ +/* define the full version of the library (string) */ +#define TNG_VERSION "@TNG_IO_VERSION@" + +#endif diff --git a/include/version.h.in b/include/version.h.in deleted file mode 100644 index 840e454..0000000 --- a/include/version.h.in +++ /dev/null @@ -1,7 +0,0 @@ -#ifndef VERSION_CONFIG_H -#define VERSION_CONFIG_H - -/* define the API version */ -#define TNG_API_VERSION @API_VERSION@ - -#endif |