param Struct Reference

The Param structure handles the parameters of the parameter file. More...

#include <types.h>

Data Fields
char	name [80]
	Name of the parameter. More...
int	type
	Type of the parameter (e.g. More...
char *	variable
	A pointer to the corresponding variable. More...
int	read
	This variable is set to YES if and only if the parameter has been found in the parameter file. More...
int	necessary
	Tell whether defining the parameter is optional or mandatory. More...

Detailed Description

The Param structure handles the parameters of the parameter file.

It allows to associate the values found in the file to the strings defining the parameters, and ultimately to the global variables associated to these strings. It is used by the function var().

Definition at line 74 of file types.h.

Field Documentation

char param::name[80]

Name of the parameter.

This is the (case insensitive) string found in the parameter file

Definition at line 75 of file types.h.

int param::necessary

Tell whether defining the parameter is optional or mandatory.

Definition at line 79 of file types.h.

Referenced by var().

int param::read

This variable is set to YES if and only if the parameter has been found in the parameter file.

Definition at line 78 of file types.h.

Referenced by ReadVariables(), and var().

int param::type

Type of the parameter (e.g.

INT, REAL, or STRING), see var.c

Definition at line 76 of file types.h.

Referenced by var().

char* param::variable

A pointer to the corresponding variable.

Definition at line 77 of file types.h.

Referenced by var().

---

The documentation for this struct was generated from the following file:

• types.h