diff options
author | Magnus Lundborg <lundborg.magnus@gmail.com> | 2013-12-03 12:02:06 (GMT) |
---|---|---|
committer | Magnus Lundborg <lundborg.magnus@gmail.com> | 2013-12-03 12:02:06 (GMT) |
commit | 16be759ab6ecc7e1f22b771b68b7e04fd7049166 (patch) | |
tree | 1b7f3f5c5c3ffa110436da71d82d6c149cf1516d /include | |
parent | f224cb5234ea8d4bbf9dff776847899fc6076c07 (diff) |
Added function tng_data_block_dependency_get()
Diffstat (limited to 'include')
-rw-r--r-- | include/tng_io.h | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/include/tng_io.h b/include/tng_io.h index 62bcef7..eddfb5c 100644 --- a/include/tng_io.h +++ b/include/tng_io.h @@ -2689,6 +2689,26 @@ tng_function_status DECLSPECDLLEXPORT tng_data_block_name_get char *name, int max_len); +/** @brief Get the dependency of a data block of a specific ID. + * @param tng_data is the trajectory data container. + * @param block_id is the ID of the data block of which to get the name. + * @param block_dependency is a pointer to the depency of the data block. + * If the block is frame dependent it will be set to TNG_FRAME_DEPENDENT, + * if it is particle dependent it will be set to TNG_PARTICLE_DEPENDENT and + * if it is both it will be set to TNG_FRAME_DEPENDENT & TNG_PARTICLE_DEPENDENT. + * @pre \code tng_data != 0 \endcode The trajectory container (tng_data) + * must be initialised before using it. + * @pre \code block_dependency != 0 \endcode The pointer to the block dependency + * must not be a NULL pointer. + * @return TNG_SUCCESS (0) if the data block is found, TNG_FAILURE (1) + * if a minor error has occured or the data block is not found or + * TNG_CRITICAL (2) if a major error has occured. + */ +tng_function_status DECLSPECDLLEXPORT tng_data_block_dependency_get + (tng_trajectory_t tng_data, + int64_t block_id, + int *block_dependency); + /** * @brief Write data of one trajectory frame to the output_file of tng_data. * @param tng_data is a trajectory data container. tng_data->output_file_path |