FiberBundleHDF5  FiberHDF5 Documentation, Revision 2026
High-Performance Fiber Bundle Data Model for Scientific Visualization
Loading...
Searching...
No Matches
F5C.h
Go to the documentation of this file.
1
2#ifndef __F5C_H
3#define __F5C_H
4
5#include "F5F.h"
6
7#ifdef __cplusplus
8extern "C"
9{
10#endif
11
12/** Set a constraint for a field in the path.
13
14 \param: fpath must at least contain a grid
15 */
16F5_API int F5Cset (F5Path* fpath, const char* fieldname, const char* content_type);
17
18/** Get the number and the names of the fields defined in this grid (including the positions field).
19
20 You have to call free(names) if you don't longer need them.
21
22 \param: fpath must at least contain a grid
23 */
24F5_API int F5Cget_fields (F5Path* fpath, size_t* count, char*** names);
25
26/** Get the constraints on a field.
27
28 You have to call free(constraints) if you don't longer need them.
29
30 \param: fpath must at least contain a grid
31 */
32F5_API int F5Cget_content_types (F5Path* fpath, const char* fieldname, size_t* count, char*** content_types);
33
34
35/** Do some string parsing to get the version of the F5 format.
36 *
37 * e.g. http://www.zib.de/visual/F5-1.0.3/Regular-1.0.0/...
38 *
39 * --> major = 1, minor = 0, patch = 3, remainder = "Regular-1.0.0/..."
40 */
41F5_API int F5Cget_version (const char* content_type, int* major, int* minor, int* patch, const char** remainder);
42
43/** Do some string parsing to get the version and name of the sub spec.
44 *
45 * e.g. http://www.zib.de/visual/F5-1.0.3/Regular-1.2.0/...
46 *
47 * --> str = "Regular", major = 1, minor = 2, patch = 0, remainder = "..."
48 */
49F5_API int F5Cget_subspec (const char* content_type, char* str, size_t size
50 , int* major, int* minor, int* patch
51 , const char** remainder);
52
53/** parse a string into name and version information.
54 *
55 * "F5-1/..."
56 * "F5-1.0/..."
57 * "F5-1.0.0/..."
58 * "F5-1"
59 * "F5-1.0"
60 * "F5-1.0.0"
61 *
62 * are all valid and the same
63 *
64 * all args are untouched in case of error
65 *
66 * \param version_string input
67 * \param str buffer to store name
68 * \param size size of buffer
69 * \param major
70 * \param minor
71 * \param patch
72 * \param remainder points to next part of version_string after '/'
73 */
74F5_API int F5Cparse_version_string (const char* version_string, char* str, size_t size
75 , int* major, int* minor, int* patch, const char** remainder);
76
77#ifdef __cplusplus
78} /* extern "C" */
79#endif
80
81#endif /* __F5C_H */
F5Cget_version
F5_API int F5Cget_version(const char *content_type, int *major, int *minor, int *patch, const char **remainder)
Definition F5contenttype.c:350
F5Cparse_version_string
F5_API int F5Cparse_version_string(const char *version_string, char *str, size_t size, int *major, int *minor, int *patch, const char **remainder)
Definition F5contenttype.c:274
F5Cget_subspec
F5_API int F5Cget_subspec(const char *content_type, char *str, size_t size, int *major, int *minor, int *patch, const char **remainder)
Definition F5contenttype.c:376
F5Cget_content_types
F5_API int F5Cget_content_types(F5Path *fpath, const char *fieldname, size_t *count, char ***content_types)
Definition F5contenttype.c:179
F5Cget_fields
F5_API int F5Cget_fields(F5Path *fpath, size_t *count, char ***names)
Definition F5contenttype.c:107
F5Cset
F5_API int F5Cset(F5Path *fpath, const char *fieldname, const char *content_type)
Definition F5contenttype.c:16
F5_API
#define F5_API
Definition F5WinDLLApi.h:11