diff options
author | Magnus Lundborg <lundborg.magnus@gmail.com> | 2013-11-20 13:20:48 (GMT) |
---|---|---|
committer | Magnus Lundborg <lundborg.magnus@gmail.com> | 2013-11-20 13:20:48 (GMT) |
commit | 43913ab1d1496e099489cf93098fc9dee15a3901 (patch) | |
tree | 686ebc59629c7cc63481013a0f8a600a38417522 /include | |
parent | 4a0a2dc5172e5e2566ea30e902acb6c45140118a (diff) |
Added function tng_data_get_stride_length()
Retrieves the stride length of a data block.
Diffstat (limited to 'include')
-rw-r--r-- | include/tng_io.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/include/tng_io.h b/include/tng_io.h index e39797f..1e7f187 100644 --- a/include/tng_io.h +++ b/include/tng_io.h @@ -2736,6 +2736,25 @@ tng_function_status DECLSPECDLLEXPORT tng_particle_data_vector_interval_get char *type); /** + * @brief Get the stride length of a specific data (particle dependency does not matter) + * block, either in the current frame set or of a specific frame. + * @param tng_data is the trajectory data container. + * @param block_id is the block ID of the data block, of which to retrieve the + * stride length of the data. + * @param frame is the frame from which to get the stride length. If frame is set to -1 + * no specific frame will be used, but instead the first frame, starting from the last read + * frame set, containing the data block will be used. + * @param stride_length is set to the value of the stride length of the data block. + * @return TNG_SUCCESS (0) if successful, TNG_FAILURE (1) if a minor error + * has occurred or TNG_CRITICAL (2) if a major error has occured. + */ +tng_function_status DECLSPECDLLEXPORT tng_data_get_stride_length + (tng_trajectory_t tng_data, + const int64_t block_id, + int64_t frame, + int64_t *stride_length); + +/** * @brief Get the date and time of initial file creation in ISO format (string). * @param tng_data is a trajectory data container. * @param time is a pointer to the string in which the date will be stored. Memory |