# Guide de référence du module MEDparameter

## Fonctions

med_int | MEDnParameter (const med_idt fid)
| Cette routine permet la lecture du nombre de paramètre numérique scalaire dans un fichier.
med_err | MEDparameterComputationStepInfo (const med_idt fid, const char *const paramname, const int csit, med_int *const numdt, med_int *const numit, med_float *const dt)
| Cette routine permet la lecture des informations relatives à une séquence de calcul du paramètre numérique scalaire.
med_err | MEDparameterCr (const med_idt fid, const char *const paramname, const med_parameter_type paramtype, const char *const description, const char *const dtunit)
| Cette routine permet la création d'un paramètre numérique scalaire.
med_err | MEDparameterInfo (const med_idt fid, const int paramit, char *const paramname, med_parameter_type *const paramtype, char *const description, char *const dtunit, med_int *const nstep)
| Cette routine permet la lecture des informations relatives à un paramètre scalaire via un itérateur.
med_err | MEDparameterInfoByName (const med_idt fid, const char *const paramname, med_parameter_type *const paramtype, char *const description, char *const dtunit, med_int *const nstep)
| Cette routine permet la lecture des informations relatives à un paramètre scalaire.
med_err | MEDparameterValueRd (const med_idt fid, const char *const paramname, const med_int numdt, const med_int numit, unsigned char *const value)
| Cette routine permet la lecture de la valeur d'un paramètre numérique scalaire.
med_err | MEDparameterValueWr (const med_idt fid, const char *const paramname, const med_int numdt, const med_int numit, const med_float dt, const unsigned char *const value)
| Cette routine permet l'écriture de la valeur d'un paramètre numérique scalaire.

## Documentation des fonctions

med_int MEDnParameter | ( | const med_idt | fid | ) |

Cette routine permet la lecture du nombre de paramètre numérique scalaire dans un fichier.

Paramètres:

  | fid | Identificateur du fichier.

Valeurs retournées:

  | medint | Nombre de paramètre.

Cette routine permet la lecture du nombre de paramètre numérique scalaire dans un fichier.

Définition à la ligne 34 du fichier MEDnParameter.c.

med_err MEDparameterComputationStepInfo | ( | const med_idt | fid,
|  | const char *const | paramname,
|  | const int | csit,
|  | med_int *const | numdt,
|  | med_int *const | numit,
|  | med_float *const | dt |
| ) |  |  |

Cette routine permet la lecture des informations relatives à une séquence de calcul du paramètre numérique scalaire.

Paramètres:

  | fid | Identificateur du fichier.
  | paramname | Nom du paramètre de longueur maximum MED_NAME_SIZE .
  | csit | Itérateur sur le numéro de séquence de calcul. L'itérateur commence à 1.
  | numdt | Numéro de pas de temps de la séquence de calcul (MED_NO_DT si pas de pas de temps).
  | numit | Numéro d'itération de la séquence de calcul (MED_NO_IT si pas de numéro d'itération).
  | dt | Date du pas de temps si le numéro de pas de temps est différent de MED_NO_DT.

Valeurs retournées:

  | med_err | retour négatif en cas d'erreur, Zéro sinon.

Cette routine permet la lecture des informations relatives à une séquence de calcul d'un paramètre numérique scalaire. L'accès à la séquence se fait par un numéro d'itération. Les informations lues sont le num d'ordre, le numéro de pas de temps et la valeur du pas de temps.

Définition à la ligne 38 du fichier MEDparameterComputationStepInfo.c.

med_err MEDparameterCr | ( | const med_idt | fid,
|  | const char *const | paramname,
|  | const med_parameter_type | paramtype,
|  | const char *const | description,
|  | const char *const | dtunit |
| ) |  |  |

Cette routine permet la création d'un paramètre numérique scalaire.

Paramètres:

  | fid | Identificateur du fichier.
  | paramname | Nom du paramètre de longueur maximum MED_NAME_SIZE .
  | paramtype | Type du paramètre.
  | description | Description, chaîne de caractères de taille maximum MED_COMMENT_SIZE caractères.
  | dtunit | Unité des pas de temps associés aux séquences de calcul du champ, définie dans une chaîne de taille MED_SNAME_SIZE .

Valeurs retournées:

  | med_err | retour négatif en cas d'erreur, Zéro sinon.

Cette routine permet la création d'un paramètre numérique scalaire. Un paramètre est identifié par son nom et se voit associer un type, une description et un ordre de tri des séquences de calcul.

Définition à la ligne 38 du fichier MEDparameterCr.c.

med_err MEDparameterInfo | ( | const med_idt | fid,
|  | const int | paramit,
|  | char *const | paramname,
|  | med_parameter_type *const | paramtype,
|  | char *const | description,
|  | char *const | dtunit,
|  | med_int *const | nstep |
| ) |  |  |

Cette routine permet la lecture des informations relatives à un paramètre scalaire via un itérateur.

Paramètres:

  | fid | Identificateur du fichier.
  | paramit | Itérateur sur les paramètres du fichier. La valeur de l'itérateur commence à 1
  | paramname | Nom du paramètre de longueur maximum MED_NAME_SIZE .
  | paramtype | Type du paramètre.
  | description | Description, chaîne de caractères de taille maximum MED_COMMENT_SIZE caractères.
  | dtunit | Unité des pas de temps associés aux séquences de calcul du champ, définie dans une chaîne de taille MED_SNAME_SIZE .
  | nstep | Nombre de séquence de calcul.

Valeurs retournées:

  | med_err | retour négatif en cas d'erreur, Zéro sinon.

Cette routine permet la lecture des informations relatives à un paramètre scalaire via un itérateur. Les informations lues sont le nom, la description, le type, l'unité des pas de temps, le mode de tri des séquences de calcul, le nombre de séquence.

Définition à la ligne 37 du fichier MEDparameterInfo.c.

med_err MEDparameterInfoByName | ( | const med_idt | fid,
|  | const char *const | paramname,
|  | med_parameter_type *const | paramtype,
|  | char *const | description,
|  | char *const | dtunit,
|  | med_int *const | nstep |
| ) |  |  |

Cette routine permet la lecture des informations relatives à un paramètre scalaire.

Paramètres:

  | fid | Identificateur du fichier.
  | paramname | Nom du paramètre de longueur maximum MED_NAME_SIZE .
  | paramtype | Type du paramètre.
  | description | Description, chaîne de caractères de taille maximum MED_COMMENT_SIZE caractères.
  | dtunit | Unité des pas de temps associés aux séquences de calcul du champ, définie dans une chaîne de taille MED_SNAME_SIZE .
  | nstep | Nombre de séquence de calcul.

Valeurs retournées:

  | med_err | retour négatif en cas d'erreur, Zéro sinon.

Cette routine permet la lecture des informations relatives à un paramètre scalaire. Le scalaire est identifié par son nom. Les informations lues sont la description, le type, l'unité des pas de temps, le mode de tri des séquences de calcul, le nombre de séquence.

Définition à la ligne 37 du fichier MEDparameterInfoByName.c.

med_err MEDparameterValueRd | ( | const med_idt | fid,
|  | const char *const | paramname,
|  | const med_int | numdt,
|  | const med_int | numit,
|  | unsigned char *const | value |
| ) |  |  |

Cette routine permet la lecture de la valeur d'un paramètre numérique scalaire.

Paramètres:

  | fid | Identificateur du fichier.
  | paramname | Nom du paramètre de longueur maximum MED_NAME_SIZE .
  | numdt | Numéro de pas de temps de la séquence de calcul (MED_NO_DT si pas de pas de temps).
  | numit | Numéro d'itération de la séquence de calcul (MED_NO_IT si pas de numéro d'itération).
  | value | Tableau des valeurs.

Valeurs retournées:

  | med_err | retour négatif en cas d'erreur, Zéro sinon.

Cette routine permet la lecture de la valeur d'un paramètre numérique scalaire pour une séquence de calcul donnée.

Définition à la ligne 37 du fichier MEDparameterValueRd.c.

med_err MEDparameterValueWr | ( | const med_idt | fid,
|  | const char *const | paramname,
|  | const med_int | numdt,
|  | const med_int | numit,
|  | const med_float | dt,
|  | const unsigned char *const | value |
| ) |  |  |

Cette routine permet l'écriture de la valeur d'un paramètre numérique scalaire.

Paramètres:

  | fid | Identificateur du fichier.
  | paramname | Nom du paramètre de longueur maximum MED_NAME_SIZE .
  | numdt | Numéro de pas de temps de la séquence de calcul (MED_NO_DT si pas de pas de temps).
  | numit | Numéro d'itération de la séquence de calcul (MED_NO_IT si pas de numéro d'itération).
  | dt | Date du pas de temps si le numéro de pas de temps est différent de MED_NO_DT.
  | value | Tableau des valeurs.

Valeurs retournées:

  | med_err | retour négatif en cas d'erreur, Zéro sinon.

Cette routine permet l'écriture de la valeur d'un paramètre numérique scalaire pour une séquence de calcul donnée.

Définition à la ligne 39 du fichier MEDparameterValueWr.c.