F5parameter.h

Go to the documentation of this file.

/*/////////////////////////////////////////////////////////////////
//
// $Id: F5parameter.h,v 1.3 2007/10/24 20:46:53 werner Exp $
//
// $Log: F5parameter.h,v $
// Revision 1.3  2007/10/24 20:46:53  werner
// close group only if valid
//
// Revision 1.2  2004/01/28 20:51:04  werner
// Cleanup/Typo fix.
//
// Revision 1.1  2004/01/28 20:43:52  werner
// Preliminiary proposed API for parameter space description.
//
//
*/
#ifndef __F5parameter_H
#define __F5parameter_H
 
#include "hdf5inc.h"
#include "F5WinDLLApi.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
/** \defgroup par Functions dealing with the parameter space.
*/
 
/** @{ */
 
/**
  Description of a parameter within the uppermost parameter space
  enveloping all Grid objects.
 */
typedef struct  structF5Parameter
{
        /** Pointer to some succeeding parameter within
            a list of parameters. */
        struct structF5Parameter*next;
        /** Name of the parameter */
        const char*name;
        /** HDF5 type of the parameter */
        hid_t      type;
 
        /** optional textual verbose description */
        const char*description;
 
}       F5Parameter;
 
/**
  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.
 */
typedef struct  structF5ParameterSpace
{
        F5Parameter*params;
 
}       F5ParameterSpace;
 
 
/**
  Delete a parameter from the parameter space.
  @todo Implement.
  */
F5_API  void F5parameter_delete(const F5ParameterSpace*, const char*name);
 
/**
  Find a parameter in the parameter space, returning NULL if none found.
  @todo Implement.
 */
F5_API  F5Parameter*F5parameter_find(const 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.
 */
F5_API  F5Parameter*F5parameter_get(F5ParameterSpace*, const char*name);
 
/**
 Load a parameter space from a file.
 @todo Implement.
 */
F5_API  F5ParameterSpace*F5parameter_load(hid_t FileID);
 
/**
 Save a parameter space into a file.
 @todo Implement.
 */
F5_API  void F5parameter_save(hid_t FileID, const F5ParameterSpace*);
 
/** @} */
 
#ifdef  __cplusplus
}    /* extern "C" */
#endif
 
#endif  /* __F5parameter_H */