FiberBundleHDF5  FiberHDF5 Documentation, Revision 2026
High-Performance Fiber Bundle Data Model for Scientific Visualization
Loading...
Searching...
No Matches
F5parameter.h
Go to the documentation of this file.
1/*/////////////////////////////////////////////////////////////////
2//
3// $Id: F5parameter.h,v 1.3 2007/10/24 20:46:53 werner Exp $
4//
5// $Log: F5parameter.h,v $
6// Revision 1.3 2007/10/24 20:46:53 werner
7// close group only if valid
8//
9// Revision 1.2 2004/01/28 20:51:04 werner
10// Cleanup/Typo fix.
11//
12// Revision 1.1 2004/01/28 20:43:52 werner
13// Preliminiary proposed API for parameter space description.
14//
15//
16*/
17#ifndef __F5parameter_H
18#define __F5parameter_H
19
20#include "hdf5inc.h"
21#include "F5WinDLLApi.h"
22
23#ifdef __cplusplus
24extern "C"
25{
26#endif
27
28/** \defgroup par Functions dealing with the parameter space.
29*/
30
31/** @{ */
32
33/**
34 Description of a parameter within the uppermost parameter space
35 enveloping all Grid objects.
36 */
37typedef struct structF5Parameter
38{
39 /** Pointer to some succeeding parameter within
40 a list of parameters. */
42 /** Name of the parameter */
43 const char*name;
44 /** HDF5 type of the parameter */
45 hid_t type;
46
47 /** optional textual verbose description */
48 const char*description;
49
51
52/**
53 The parameter space. Basically a root node for
54 a list of parameters. This struct is probably
55 not required, as we can use the F5Parameter itself
56 that already provides a list.
57 */
63
64
65/**
66 Delete a parameter from the parameter space.
67 @todo Implement.
68 */
70
71/**
72 Find a parameter in the parameter space, returning NULL if none found.
73 @todo Implement.
74 */
76/**
77 Get an parameter entry from a parameter space by either finding an
78 existing one or creating and inserting a new one.
79 @todo Implement.
80 */
82
83/**
84 Load a parameter space from a file.
85 @todo Implement.
86 */
88
89/**
90 Save a parameter space into a file.
91 @todo Implement.
92 */
93F5_API void F5parameter_save(hid_t FileID, const F5ParameterSpace*);
94
95/** @} */
96
97#ifdef __cplusplus
98} /* extern "C" */
99#endif
100
101#endif /* __F5parameter_H */
102
name
Definition F5P.c:82
#define F5_API
Definition F5WinDLLApi.h:11
F5_API F5ParameterSpace * F5parameter_load(hid_t FileID)
struct structF5Parameter F5Parameter
F5_API void F5parameter_delete(const F5ParameterSpace *, const char *name)
F5_API F5Parameter * F5parameter_find(const F5ParameterSpace *, const char *name)
F5_API void F5parameter_save(hid_t FileID, const F5ParameterSpace *)
struct structF5ParameterSpace F5ParameterSpace
F5_API F5Parameter * F5parameter_get(F5ParameterSpace *, const char *name)
F5Parameter * params
Definition F5parameter.h:60
struct structF5Parameter * next
Definition F5parameter.h:41
const char * name
Definition F5parameter.h:43
const char * description
Definition F5parameter.h:48