summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMagnus Lundborg <lundborg.magnus@gmail.com>2013-12-03 12:51:23 (GMT)
committerMagnus Lundborg <lundborg.magnus@gmail.com>2013-12-03 12:51:23 (GMT)
commitb4783da8473431eb91bc82861f49bcb402c6f163 (patch)
tree5b3cb5947bdd9f8ecd9508d36fbc185dc86807f3 /include
parent16be759ab6ecc7e1f22b771b68b7e04fd7049166 (diff)
Added function tng_data_block_num_values_per_frame_get()
Diffstat (limited to 'include')
-rw-r--r--include/tng_io.h19
1 files changed, 18 insertions, 1 deletions
diff --git a/include/tng_io.h b/include/tng_io.h
index eddfb5c..bca3978 100644
--- a/include/tng_io.h
+++ b/include/tng_io.h
@@ -2692,7 +2692,7 @@ tng_function_status DECLSPECDLLEXPORT tng_data_block_name_get
/** @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.
+ * @param block_dependency is a pointer to the dependency 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.
@@ -2709,6 +2709,23 @@ tng_function_status DECLSPECDLLEXPORT tng_data_block_dependency_get
int64_t block_id,
int *block_dependency);
+/** @brief Get the number of values per frame 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 n_values_per_frame is a pointer set to the number of values per frame.
+ * @pre \code tng_data != 0 \endcode The trajectory container (tng_data)
+ * must be initialised before using it.
+ * @pre \code n_values_per_frame != 0 \endcode The pointer to the number of values
+ * per frame 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_num_values_per_frame_get
+ (tng_trajectory_t tng_data,
+ int64_t block_id,
+ int *n_values_per_frame);
+
/**
* @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
contact: Jan Huwald // Impressum