Functions dealing with the parameter space.

Data Structures
struct	structF5Parameter
struct	structF5ParameterSpace

Typedefs
typedef struct structF5Parameter	F5Parameter
typedef struct structF5ParameterSpace	F5ParameterSpace

Functions
F5_API void	F5parameter_delete (const F5ParameterSpace *, const char *name)
F5_API F5Parameter *	F5parameter_find (const F5ParameterSpace *, const char *name)
F5_API F5Parameter *	F5parameter_get (F5ParameterSpace *, const char *name)
F5_API F5ParameterSpace *	F5parameter_load (hid_t FileID)
F5_API void	F5parameter_save (hid_t FileID, const F5ParameterSpace *)

Detailed Description

Typedef Documentation

F5Parameter

typedef struct structF5Parameter F5Parameter

Description of a parameter within the uppermost parameter space enveloping all Grid objects.

F5ParameterSpace

typedef struct structF5ParameterSpace F5ParameterSpace

The parameter space. Basically a root node for a list of parameters. This struct is probably not required, as we can use the F5Parameter itself that already provides a list.

Function Documentation

F5parameter_delete()

F5_API void F5parameter_delete	(	const F5ParameterSpace *	,
		const char *	name
	)

Delete a parameter from the parameter space.

Todo:

Implement.

F5parameter_find()

F5_API F5Parameter* F5parameter_find	(	const F5ParameterSpace *	,
		const char *	name
	)

Find a parameter in the parameter space, returning NULL if none found.

Todo:

Implement.

F5parameter_get()

F5_API F5Parameter* F5parameter_get	(	F5ParameterSpace *	,
		const char *	name
	)

Get an parameter entry from a parameter space by either finding an existing one or creating and inserting a new one.

Todo:

Implement.

F5parameter_load()

F5_API F5ParameterSpace* F5parameter_load

(

hid_t

FileID

)

Load a parameter space from a file.

Todo:

Implement.

F5parameter_save()

F5_API void F5parameter_save	(	hid_t	FileID,
		const F5ParameterSpace *
	)

Save a parameter space into a file.

Todo:

Implement.