Sens affectés aux paramètres des méthodes :
(E) |
Entrée |
(S) |
Sortie |
(E/S) |
Entrée et Sortie |
Liste des codes retour des différentes méthodes :
_ECHDO_ERR_OK |
L'exécution de la méthode s'est déroulée correctement. |
_ECHDO_ERR_TYPE |
Au moins une des variables de la méthode ne possède pas le bon type Adélia. |
_ECHDO_ERR_NON_CONNEXION |
L'objet n'est pas connecté. |
_ECHDO_ERR_EXEC |
Une anomalie s'est produite en cours d'exécution (ce cas ne doit jamais se produire). |
_ECHDO_ERR_PARAM |
La valeur d'au moins un des paramètres est invalide. |
_ECHDO_ERR_VAR_NON_DISPO |
Les données à lire ne possèdent pas d'information du type Adélia demandé. |
_ECHDO_ERR_LG_CHAINE |
Les données à lire contiennent une chaîne de caractères dont la taille est supérieure à celle de la variable Adélia. |
_ECHDO_ERR_DELAI_EXPIRE |
Au cours de l'utilisation de la méthode VALIDER en mode synchrone, un objet échange de données a dépassé le temps de réponse autorisé. |
_ECHDO_ERR_APPEL_EN_COURS |
Un appel à la méthode VALIDER en mode synchrone a été effectué alors qu'un précédent appel en mode synchrone est en cours d'exécution. |
Cette méthode efface les données en cours de construction : les données ajoutées par la méthode ECRIRE depuis le dernier appel de la méthode VALIDER ne seront pas prises en compte lors du prochain appel de la méthode VALIDER.
| Syntaxe | ||
APPELER_METHODE NomObjetEchangeDonnees ANNULER CodeRetour |
||
Paramètres |
||
CodeRetour (S) |
NUM_BIN_4 |
Code retour de la méthode Valeurs possibles:
|
ReturnCode (O) |
NUM_BIN_4 |
Return code for the method. Valeurs possibles: _ECHDO_ERR_OK _ECHDO_ERR_EXEC |
Conditions d'utilisation |
Aucune |
|
Connecte l'objet à tous les objets de la machine gérant le même nom de données. Si le paramètre ReceptionDonnees est à *VRAI, la donnée courante est alors disponible, c'est-à-dire lisible par l'objet. De plus, l'objet reçoit alors un événement lors de chaque changement de données, la méthode de lecture fournissant alors les nouvelles données.
Si l'objet est déjà connecté, la nouvelle valeur du paramètre ReceptionDonnees est prise en compte.
En particulier, si l'objet se connecte sans réception de données alors qu'il était connecté avec réception de données, les données disponibles au moment du changement restent lisibles pour l'objet ; elles ne sont plus remplacées par les nouvelles données.
| Syntaxe | ||
APPELER_METHODE NomObjetEchangeDonnees CONNECTER ReceptionDonnees CodeRetour |
||
Paramètres |
||
ReceptionDonnees (E) |
BOOL |
Réception ou non des nouvelles données et survenue d'un événement dans l'objet lors d'un changement de données (lors de l'utilisation de la méthode VALIDER) |
CodeRetour (S) |
NUM_BIN_4 |
Code retour de la méthode Valeurs possibles: _ECHDO_ERR_OK _ECHDO_ERR_EXEC |
Conditions d'utilisation |
Aucune |
|
Déconnecte l'objet de l'ensemble des objets gérant le même nom de données. L'objet ne peut alors plus recevoir d'événements, et ne peut plus lire les données.
| Syntaxe | ||
APPELER_METHODE NomObjetEchangeDonnees DECONNECTER CodeRetour |
||
Paramètres |
||
CodeRetour (S) |
NUM_BIN_4 |
Code retour de la méthode Valeurs possibles: _ECHDO_ERR_OK _ECHDO_ERR_EXEC |
Conditions d'utilisation |
Aucune |
|
Ajoute des données (le contenu des variables Adélia) aux données en cours de construction. Ces données ne sont pas encore disponibles pour les autres objets gérant le même nom de données. Ces informations sont stockées dans l'objet jusqu'à la validation ou l'annulation suivante. Il est à noter qu'aucune distinction n'est faite entre les variables de type numérique étendu et condensé.
| Syntaxe | ||
APPELER_METHODE NomObjetEchangeDonnees ECRIRE VarAdelia NbDonnees CodeRetour |
||
Paramètres |
||
VarAdelia (E) |
Types possibles : |
Variable ou tableau |
NbDonnees (E/S) |
NUM_BIN_4 |
Nombre d'informations à ajouter. Ce paramètre doit valoir '1' pour une variable, et doit être inférieur ou égal au nombre d'éléments du tableau pour un tableau. Après appel de la méthode, il contient le nombre d'informations écrites. |
CodeRetour (S) |
NUM_BIN_4 |
Code retour de la méthode Valeurs possibles: _ECHDO_ERR_OK _ECHDO_ERR_TYPE _ECHDO_ERR_PARAM _ECHDO_ERR_EXEC |
Conditions d'utilisation |
Aucune |
|
Cette méthode fixe la valeur de variables Adélia en lisant les données disponibles. Elle doit être utilisée en boucle pour parcourir toutes les données d'un type Adélia donné. Toutes les données d'un type sont lues lorsque le nombre de données lues est strictement inférieur au nombre de données à lire. Il est à noter qu'aucune distinction n'est faite entre les variables de type numérique étendu et condensé, quels que soient la longueur et le nombre de décimales. Les valeurs des variables de type numérique ou étendu peuvent donc être tronquées lors de la lecture. Concernant les chaînes, la lecture échoue si la taille de la variable Adélia est insuffisante pour contenir la chaîne lue.
| Syntaxe | ||
APPELER_METHODE NomObjetEchangeDonnees LIRE VarAdelia Indice NbDonnees CodeRetour |
||
Paramètres |
||
VarAdelia (S) |
Types possibles : |
Variable ou tableau |
Indice (E) |
NUM_BIN_4 |
Indice de l'information à lire pour un type donné. La première information possède l'indice '1'. |
NbDonnees (E/S) |
NUM_BIN_4 |
Nombre d'informations à lire. Ce paramètre doit valoir '1' pour une variable, et doit être inférieur ou égal au nombre d'éléments du tableau pour un tableau. Après appel de la méthode, il contient le nombre d'informations lues. |
CodeRetour (S) |
NUM_BIN_4 |
Code retour de la méthode Valeurs possibles: _ECHDO_ERR_OK _ECHDO_ERR_TYPE _ECHDO_ERR_PARAM _ECHDO_ERR_EXEC _ECHDO_ERR_NON_CONNEXION _ECHDO_ERR_LG_CHAINE _ECHDO_ERR_VAR_NON_DISPO |
Conditions d'utilisation |
L'objet doit être connecté. |
|
Met les données en cours de construction à disposition de tous les objets gérant le même nom de données. Ces données deviennent les données courantes. Les objets connectés pour lesquels la réception d'un événement est autorisée reçoivent un événement de changement de données. Les données en construction de l'objet depuis lequel la méthode est appelée sont alors effacées.
Si la validation est effectuée en mode asynchrone, le code Adélia qui suit l'appel de la méthode VALIDER s'exécute immédiatement après cet appel. Les événements ChangementDonnees reçus par les objets Echange de données arrivent ultérieurement, que les objets appartiennent ou non au même processus.
Par contre, si la validation est faite en mode synchrone, le code Adélia qui suit l'appel à la méthode VALIDER ne s'exécute que lorsque tous les objets Echange de Donnees ont reçu et géré l'événement ChangementDonnees, que ces objets appartiennent ou non au même processus. Dans ce cas, la méthode VALIDER peut échouer pour cause de délai d'expiration dépassé.
| Syntaxe | ||
APPELER_METHODE NomObjetEchangeDonnees VALIDER CodeRetour |
||
Paramètres |
||
CodeRetour (S) |
NUM_BIN_4 |
Code retour de la méthode Valeurs possibles: _ECHDO_ERR_OK _ECHDO_ERR_EXEC _ECHDO_ERR_NON_CONNEXION _ECHDO_ERR_DELAI_EXPIRE (mode synchrone) _ECHDO_ERR_APPEL_EN_COURS (mode synchrone) |
Conditions d'utilisation |
L'objet doit être connecté. |
|
Cliquer ici pour voir un exemple.