TREND
Modification des caractéristiques d'une courbe de tendance.
Support WebVue partiel. Voir le tableau avec la liste des modes ci-dessous. Les modes non supportés renvoient un code d'erreur si exécutés dans ce contexte.
Lors de l'utilisation de régions multiples, vous devez positionner la région avant l'exécution d'instructions qui interagissent avec l'IHM. Pour plus d'informations, voir la rubrique REGION.
| Mode | Mnémonique | Syntaxe | Support WebVue |
| 1 | SETTYPE | 1 | Oui |
| 2 | GETTYPE | 2 | Non |
| 3 | SETYRANGE | 3 | Oui |
| 4 | GETYMIN | 4 | Non |
| 5 | GETYMAX | 4 | Non |
| 6 | SETPERIOD | 5 | Non |
| 7 | GETPERIOD | 6 | Non |
| 8 | SETDATETIME | 7 | Oui |
| 9 | SETDATETIMEPERIOD | 8 | Non |
| 10 | SCROLLPERCENT | 9 | Non |
| 11 | SCROLLTIME | 10 | Non |
| 12 | GETDATETIME | 11 | Non |
| 13 | GETCURSORVALUE | 4 | Non |
| 14 | SETVAR | 12 | Oui |
| 15 | GETVAR | 13 | Non |
| 16 | ADDVARLIST | 14 | Non |
| 17 | SETVARLIST | 15 | Non |
| 18 | SETVARBUF | 16 | Non |
| 19 | RESETVAR | 17 | Non |
| 20 | CLEARVAR | 17 | Oui |
| 21 | CHANGEID | 18 | Non |
| 22 | SETTIMECAPACITY | 5 | Non |
| 23 | SETCOLOR | 19 | Oui |
| 24 | SETSTYLE | 1 | Oui |
| 25 | HARDCOPY | 20 | Non |
| 26 | GETSTYLE | 22 | Non |
| 27 | SETYMIN | 21 | Oui |
| 28 | SETYMAX | 21 | Oui |
| 29 | GETCOLORRED | 22 | Non |
| 30 | GETCOLORGREEN | 22 | Non |
| 31 | GETCOLORBLUE | 22 | Non |
| 32 | REFRESH | 20 | Non |
| 33 | THRESHOLD_SETMODE | 23 | Non |
| 35 | THRESHOLD_SETPROP | 24 | Non |
| 36 | THRESHOLD_SETVALUE | 25 | Non |
| 37 | THRESHOLD_DRAWLINE | 26 | Non |
| 38 | DRAW_MINLINE | 27 | Non |
| 39 | DRAW_MAXLINE | 27 | Non |
| 40 | DISPLAY_MINMAXLINE | 30 | Non |
| 41 | SETTIMEORIGIN | 28 | Non |
| 42 | SETTIMEOFFSET | 29 | Non |
| 43 | EXPORT | 20 | Non |
| 44 | SET_VISIBLE | 31 | Non |
| 45 | DISPLAY_SCALE | 31 | Non |
| 46 | THRESHOLD_GETMODE | 4 | Non |
| 47 | THRESHOLD_GETVALUE | 32 | Non |
| 48 | THRESHOLD_ISCHECKED | 32 | Non |
| 49 | THRESHOLD_ISDRAWLINE | 32 | Non |
| 50 | THRESHOLD_GETCOLOR | 32 | Non |
| 51 | THRESHOLD_GETSTYLE | 32 | Non |
| 52 | SHOW_LEGEND | 33 | Non |
| 54 | GETCONFIG | 34 | Non |
| 55 | SETCONFIG | 35 | Oui |
| 56 | GETCONFIG_ASYNC | 36 | Oui |
| 57 | SETSAVERUNTIMEPROPS | 37 | Non |
Toutes Syntaxes
|
Argument |
Définition |
| Window | Nom de la fenêtre qui contient la fenêtre de tendance utilisée. Type STR |
| Branch | Branche de la fenêtre (si elle existe). Utiliser un "*" signifie la branche courante du programme. Type STR. |
| Identity | Identifiant de l'animation fenêtre de tendance dans la fenêtre spécifiée. Type STR |
| Trace |
Numéro de la plume à modifier. Type INTEGER, valeur 0 à 100. Lorsqu'une fonction se rapporte à une seule plume, cette plume est identifiée par un paramètre appelé Trace prenant une valeur entre 1 et 100. Par contre, si ce numéro de plume est 0 ou omis, alors toutes les plumes de la fenêtre de tendance seront affectées par la modification. |
Les paramètres contenant des horodates sont de type DOUBLE. Une horodate est toujours une valeur représentant le nombre de millisecondes écoulées depuis le 1er janvier 1980.
Syntaxe 1
IntVal = TREND( Mode, Window, Branch, Identity, Trace, SubMode);
Type de retour : INTEGER.
|
Argument |
Définition |
| SubMode | Mode d'opération pour le tracé sélectionné. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
|
1 |
SETTYPE |
Modification du mode pour toutes les plumes, pour basculer en historique (SubMode=2) ou en temps-réel (SubMode=1). Le paramètre Trace n'est pas pris en compte et doit être positionné à 0. |
|
24 |
SETSTYLE |
Permet de modifier le style de la plume selon le paramètre SubMode : 0 Carré 1 Triangle 2 Séries de points |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 2
IntVal = TREND(Mode, Window, Branch, Identity, Trace);
Type de retour : INTEGER
Exécution
|
Mode |
Mnémonique |
Action |
|
2 |
GETTYPE |
Retourne le Mode de fonctionnement de toutes les plumes. Le paramètre Trace n'est pas pris en compte et doit être positionné à 0. Retour : 1 si temps-réel. 2 si historique. 0 si erreur. |
Syntaxe 3
IntVal = TREND(Mode, Window, Branch, Identity, Trace [, Ymin, YMax]);
Type de retour : INTEGER
|
Argument |
Définition |
|
Ymin, YMax |
Valeur pour la plume sélectionnée. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
|
3 |
SETYRANGE |
Modification les valeurs min. et max. en Y d'une courbe de tendance. Lorsque les paramètres Ymin et Ymax sont omis, les valeurs min. et max. de la variable en tendance sont utilisées. Si Trace est 0 alors toutes les plumes sont affectées. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 4
DblVal = TREND(Mode, Window, Branch, Identity, Trace);
Type de retour : DOUBLE
Exécution
|
Mode |
Mnémonique |
Action |
|
4 |
GETYMIN |
Retourne la valeur min. de l'échelle des ordonnées d'une courbe de tendance. |
|
5 |
GETYMAX |
Retourne la valeur max. de l'échelle des ordonnées d'une courbe de tendance. |
|
13 |
GETCURSORVALUE |
Retourne la valeur d'une variable d'une courbe de tendance à la position courante du curseur. |
| 46 | THRESHOLD_GETMODE |
Retourne le système de seuils associé à une plume. -1 Pas de seuils 0 Automatique (c'est-à-dire en fonction de la configuration de la variable) 1 ppphi/pphi/phi/hi 2 pphi/phi/hi/lo 3 phi/hi/lo/plo 4 hi/lo/plo/pplo 5 lo/plo/pplo/ppplo |
| Retour: DBL_MIN en cas d'erreur. |
Syntaxe 5
IntVal = TREND(Mode, Window, Branch, Identity, Duration[, ForceHistoricalRequest]);
Type de retour : INTEGER
|
Argument |
Définition |
|
Duration |
Période exprimée en millisecondes. Type DOUBLE. |
| ForceHistoricalRequest | Indicateur permettant de forcer une requête aux historiques, positionner à 0 si vous ne souhaitez pas forcer une requête (par défaut), positionner à 1 si vous souhaitez une telle requête. Type INTEGER. Dans certaines circonstances, en fonction de la configuration de la fenêtre de tendance et de ses conditions d'utilisation, le concepteur de l'application peut souhaiter forcer une telle requête aux historiques. Par exemple, si une fenêtre de tendance est conçue pour rester ouverte pendant de longues périodes de temps, les plumes seront tracées sur la base d'une requête aux historiques au moment de l'ouverture du synoptique, mais après un certain temps, la plupart des points affichés seront issus de valeurs temps réel. Si l'utilisateur change alors la période de temps, en réduisant sur une période courte du passé récent, il pourrait ne pas y avoir de point issu des historiques à afficher. Dans un tel cas, vous souhaiterez positionner ce paramètre à 1 pour être certain que la fenêtre de tendance aura des points à afficher. |
Exécution
|
Mode |
Mnémonique |
Action |
|
6 |
SETPERIOD |
Modification de la durée de visualisation des courbes de tendance. |
|
22 |
SETTIMECAPACITY |
Modification de la durée (capacité) de stockage du buffer d'affichage pour le temps réel. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 6
DblVal = TREND(Mode, Window, Branch, Identity);
Type de retour : DOUBLE
Exécution
|
Mode |
Mnémonique |
Action |
|
7 |
GETPERIOD |
Retourne la période de l'axe X exprimée en millisecondes. Retour: DBL_MIN en cas d'erreur. |
Syntaxe 7
IntVal = TREND(Mode, Window, Branch, Identity, StartTime, EndTime]);
Type de retour : INTEGER
|
Argument |
Définition |
|
StartTime |
Horodate de début exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. Type DOUBLE. |
|
EndTime |
Horodate de fin exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
|
8 |
SETDATETIME |
Modification des horodates de début et de fin d'affichage des courbes de tendance. Lorsque le paramètre EndTime est omis, seul l'horodate de début est modifiée et la durée ne change pas. Retour : 1 si OK, 0 sinon. |
Syntaxe 8
IntVal = TREND(Mode, Window, Branch, Identity, StartTime, Duration);
Type de retour : INTEGER
|
Argument |
Définition |
|
StartTime |
Horodate de début exprimée en nombre de millisecondes depuis 1980. Voir l'instruction DateTimeValue. Type DOUBLE. |
|
Duration |
Période exprimée en millisecondes. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
|
9 |
SETDATETIMEPERIOD |
Modification des horodates de début et de fin d'affichage des courbes de tendance. Retour : 1 si OK, 0 sinon. |
Syntaxe 9
IntVal = TREND(Mode, Window, Branch, Identity, PScroll);
Type de retour : INTEGER
|
Argument |
Définition |
|
Pscroll |
Le pourcentage par lequel l'axe de tendance X sera défilé. Pourcentage compris entre -100 et +100 inclus. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
|
10 |
SCROLLPERCENT |
Déplacement dans le temps des courbes de tendance. Le déplacement est exprimé en pourcentage de la durée de l'échelle des temps. Un pourcentage négatif indique un déplacement en arrière dans le temps et un pourcentage positif un déplacement en avant. Un pourcentage à 0 recale les courbes sur l'horodate courante. Retour : 1 si OK, 0 sinon. |
Syntaxe 10
IntVal = TREND(Mode, Window, Branch, Identity, TScroll);
Type de retour : INTEGER
|
Argument |
Définition |
|
Tscroll |
Période exprimée en millisecondes. Type DOUBLE. |
Exécution
|
Mode |
Mnémonique |
Action |
|
11 |
SCROLLTIME |
L'axe X de la tendance est défilé par la période fournie. Un temps négatif indique un déplacement en arrière dans le temps et un temps positif un déplacement en avant dans le temps. Retour : 1 si OK, 0 sinon. |
Syntaxe 11
DblVal = TREND(Mode, Window, Branch, Identity, Trace, Function);
Type de retour : DOUBLE
|
Argument |
Définition |
|
Function |
Indicateur d'opération. Type INTEGER, valeur 1 à 3. |
Exécution
|
Mode |
Mnémonique |
Action |
|
12 |
GETDATETIME |
Retourne l'horodate de la tendance exprimée en nombre de millisecondes depuis 1980, selon l'argument Function : 1 Horodate de début 2 Horodate de fin 3 Horodate au curseur Retour : DBL_MIN en cas d'erreur. |
Syntaxe 12
IntVal = TREND(Mode, Window, Branch, Identity, ClearFlag, Trace, VarName[, Label[ Type]]);
Type de retour : INTEGER
|
Argument |
Définition |
|
ClearFlag |
Indicateur de traitement de la plume courante. Type INTEGER, valeur 0 ou 1. |
|
VarName |
Nom de la variable à afficher. Type STR. |
|
Label |
Libellé affiché dans la bordure gauche de la tendance. Type STR. |
|
Type |
Indicateur du Mode d'opération du tracé. Type INTEGER, valeur 0 à 2. |
Exécution
|
Mode |
Mnémonique |
Action |
|
14
|
SETVAR |
Modification du nom de la variable pour la courbe spécifiée, selon ClearFlag. 0 Les courbes présentes sont conservées. 1 Les courbes présentes sont supprimées. Mode d'opération indiqué par l'argument Type : 0 Pas de changement de type de courbe 1 Courbe de type temps réel. 2 Courbe de type historique.
Retour : 1 si OK, 0 sinon. |
Syntaxe 13
StrVal = TREND(Mode, Window, Branch, Identity, Trace);
Type de retour : STR
Exécution
|
Mode |
Mnémonique |
Action |
|
15 |
GETVAR |
Renvoie le nom de la variable correspondant à une plume. Retour : Une chaîne vide en cas d'erreur. |
Syntaxe 14
IntVal = TREND(Mode, Window, Branch, Identity, Trace, Varname[, Label [ Type]]);
Type de retour : INTEGER
|
Argument |
Définition |
|
VarName |
Nom de la variable à afficher. Type STR. |
|
Label |
Libellé affiché dans la bordure gauche de la tendance. Type STR. |
|
Type |
Indicateur du Mode d'opération du tracé. Type INTEGER, valeur 0 à 2. |
Exécution
|
Mode |
Mnémonique |
Action |
|
16 |
ADDVARLIST |
Permet la préparation d'une modification portant sur plusieurs plumes d'une animation courbe de tendance. Des appels successifs à AddVarList permettent de constituer la liste des courbes à modifier et un appel à SetVarList applique la modification. Le changement ne se fait que lorsque suivi par une instruction en mode 17. Un certain nombre d'instructions de mode 16 sont généralement suivies par une instruction de mode 17 pour permettre un certain nombre de traces sur la même Tendance affichage à changer simultanément. Mode d'opération indiqué par l'argument Type : 0 Pas de changement de type de courbe 1 Courbe de type temps réel. 2 Courbe de type historique.
Retour : 1 si OK, 0 sinon. |
Syntaxe 15
IntVal = TREND(Mode, Window, Branch, Identity, ClearFlag)
Type de retour : INTEGER
Exécution
|
Mode |
Mnémonique |
Action |
|
17 |
SETVARLIST |
Utilisé avec le Mode ADDVARLIST pour modifier les variables associées à un ensemble de plumes d'une fenêtre de tendance en une fois. Les plumes précédentes sont conservées ou effacées en fonction de ClearFlag:: 0 Préserver 1 Effacer Retour : 1 si OK, 0 sinon. |
Syntaxe 16
IntVal = TREND(Mode, Window, Branch, Identity, ClearFlag, Handle)
Type de retour : INTEGER
|
Argument |
Définition |
|
Handle |
Localisation du buffer mémoire crée par l'instruction FILETOBUF. Type LONG. |
|
ClearFlag |
Voir ci-dessous |
Exécution
|
Mode |
Mnémonique |
Action |
|
18 |
SETVARBUF |
Permet de modifier simultanément plusieurs plumes. Les paramètres de modification doivent être préparés dans un buffer mémoire selon ClearFlag: 0 Les courbes présentes sont préservées. 1 Les courbes présentes sont effacées. |
|
|
|
La syntaxe pour chaque ligne du buffer mémoire doit être la suivante : Trace, VarName, Label, Type |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 17
IntVal = TREND(Mode, Window, Branch, Identity[, Trace]);
Type de retour : INTEGER
Exécution
|
Mode |
Mnémonique |
Action |
|
19 |
RESETVAR |
Permet de réinitialiser une fenêtre de tendance avec les paramètres de configuration. Toutes les plume sont affectées si Trace = 0. |
|
20 |
CLEARVAR |
Permet de supprimer une ou toutes les plumes d'une fenêtre de tendance. Toutes les plumes sont affectées si Trace = 0. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 18
IntVal = TREND(Mode, Window, Branch, Identity, NewIdentity);
Type de retour : INTEGER
|
Argument |
Définition |
|
NewIdentity |
Nouveau repère de l'animation Tendance. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
|
21 |
CHANGEID |
Modifie dynamiquement le repère d'une fenêtre de Tendance. Retour : 1 si OK, 0 sinon. |
Syntaxe 19
IntVal = TREND(Mode, Window, Branch, Identity, Trace, Red, Green, Blue);
Type de retour : INTEGER
|
Argument |
Définition |
|
Red |
Composant rouge de la couleur. Type INTEGER, valeur 0 à 255. |
|
Green |
Composant vert de la couleur. Type INTEGER, valeur 0 à 255. |
|
Blue |
Composant bleu de la couleur. Type INTEGER, valeur 0 à 255. |
Exécution
|
Mode |
Mnémonique |
Action |
|
23 |
SETCOLOR |
Permet de changer la couleur d'une plume. Change aussi la couleur de la courbe invalide et de l'échelle. Retour : 1 si OK, 0 sinon. |
Syntaxe 20
IntVal = TREND(Mode, Window, Branch, Identity);
Type de retour : INTEGER
Exécution
|
Mode |
Mnémonique |
Action |
|
25 |
HARDCOPY |
Copie d'écran (proportionnelle) de la fenêtre de tendance. |
|
32 |
REFRESH |
Effectue une requête aux historiques. |
| 42 | EXPORT | Enclenche un Export de tendances. L'effet est similaire au bouton Export d'une fenêtre de tendances. |
|
|
|
Retour : 1 si OK, 0 sinon. |
L'effet de HARDCOPY est similaire au bouton Impression de la barre d'outils.
Syntaxe 21
IntVal = TREND(Mode, Window, Branch, Identity, Trace, dbY);
Type de retour : INTEGER
|
Argument |
Définition |
|
dbY |
Valeur minimum ou maximum de l'échelle de la courbe. |
Exécution
|
Mode |
Mnémonique |
Action |
|
27 |
SETYMIN |
Positionne la valeur minimum de l’échelle pour une plume. |
|
28 |
SETYMAX |
Positionne la valeur maximum de l'échelle pour une plume. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Si les Min et Max sont à 0, ce seront les valeurs Min et Max de la variable qui seront utilisées à la place.
Syntaxe 22
IntVal = TREND(Mode, Window, Branch, Identity, Trace);
Type de retour : INTEGER
Exécution
|
Mode |
Mnémonique |
Action |
|
26 |
GETSTYLE |
Renvoie le type de tracé pour une plume. Retour : 0 Carré 1 Triangle 2 Séries de points |
|
29 |
GETCOLORRED |
Retour : 0 à 255 : La composante rouge de la couleur de la plume |
|
30 |
GETCOLORGREEN |
Retour : 0 à 255 : La composante verte de la couleur de la plume |
|
31 |
GETCOLORBLUE |
Retour : 0 à 255 : La composante bleue de la couleur de la plume |
|
Retour : -1 en cas d’erreur (la plume n'est pas utilisée, ou l'instruction n'est pas supportée dans ce contexte) |
Syntaxe 23
IntVal = TREND(Mode, Window, Branch, Identity, Trace, ThresholdMode[, ThresholdValue1, DisplayThreshold1[, ThresholdValue2, DisplayThreshold2[, ThresholdValue3, DisplayThreshold3[, ThresholdValue4, DisplayThreshold4]]]]);
Type de retour : INTEGER.
|
Argument |
Définition |
| ThresholdMode | Nouveau mode de seuils. Type INTEGER, de -1 à 5. Voir tableau ci-dessous. |
| ThresholdValueN | Nouvelle valeur du seuil N. Tout type numérique. |
| DisplayThresholdN |
Mode d'affichage du seuil N. Type INTEGER. |
Exécution
|
Mode |
Mnémonique |
Action |
| 33 | THRESHOLD_SETMODE |
Modifie l'affichage de la configuration du seuil pour la trace sélectionnée. Retour : 1 si OK, 0 sinon. |
Threshold mode
| Mode | Système de seuil |
| -1 | Aucun |
| 0 | Depuis la configuration de la variable |
| 1 | ppphigh/pphigh/hihi/high |
| 2 | pphigh/hihi/high/low |
| 3 | hihi/high/low/lolo |
| 4 | high/low/lolo/pplow |
| 5 | low/lolo/pplow/ppplow |
Syntaxe 24
IntVal = Trend(Mode, Window, Branch, Identity, Trace, ThresholdNumber, Red, Green, Blue[, PenStyle[, DrawThresholdLine]]);
Type de retour : INTEGER.
|
Argument |
Définition |
| ThresholdNumber | Numéro identifiant le seuil. Type INTEGER, de 0 à 3. |
| Red | Composant rouge de la couleur du seuil. Type INTEGER, de -1 à 255. |
| Blue | Composant bleu de la couleur du seuil. Type INTEGER, de -1 à 255. |
| Green | Composant vert de la couleur du seuil. Type INTEGER, de -1 à 255. |
| PenStyle | Style de ligne du seuil. Optionnel. Voir tableau ci-dessous |
| DrawThresholdLine | Flag indiquant si la ligne du seuil est dessinée. Optionnel. Type INTEGER 0 masque la ligne, 1 dessine la ligne (valeur par défaut si le paramètre est omis). |
Mode du seuil
|
Mode |
Mnémonique |
Action |
| 35 | THRESHOLD_SETPROP |
Modifie les propriétés du seuil sélectionné. La couleur est celle de la plume au dépassement du seuil. Si -1 est utilisé pour chaque composant de couleur, la couleur ne change pas. Retour : 1 si OK, 0 sinon. |
Style de tracé
| Valeur | Style |
| 0 | Plein _______ - Valeur par défaut si le paramètre est omis. |
| 1 | Tirets ------- |
| 2 | Pointillés ....... |
| 3 | Tirets pointillés _._._._ |
| 4 | Tirets Pointillés Pointillés _.._.._ |
Syntaxe 25
IntVal = Trend(Mode, Window, Branch, Identity, Trace, ThresholdNumber, ThresholdValue);
Type de retour : INTEGER.
|
Argument |
Définition |
| ThresholdNumber | Numéro identifiant le seuil. Type INTEGER, de 0 à 3. |
| ThresholdValue | Nouvelle valeur pour le seuil sélectionné. Tout type numérique. |
Style de tracé
|
Mode |
Mnémonique |
Action |
| 36 | THRESHOLD_SETVALUE |
Modifie la valeur du seuil sélectionné. Retour : 1 si OK, sinon 0 en cas d'erreur (Identity introuvable, ou l'instruction n'est pas supportée dans ce contexte). -1 la plume n'est pas utilisée. -2 La valeur ThresholdNumber est hors plage. -3 Aucun système de seuils n'est configuré. -4 La valeur ThresholdValue ne correspond pas au système de seuils configuré (hihi<hi par exemple). |
Syntaxe 26
IntVal = Trend(Mode, Window, Branch, Identity, Trace, ThresholdNumber[, DrawThresholdLine]);
Type de retour : INTEGER.
|
Argument |
Définition |
| ThresholdNumber | Numéro identifiant le seuil. Type INTEGER, de -1 à 3. Une valeur de -1 signifie tous les seuils. |
| DrawThresholdLine | Flag indiquant si la ligne du seuil est dessinée. Optionnel. Type INTEGER 0 masque la ligne, 1 dessine la ligne (valeur par défaut si le paramètre est omis). |
Exécution
|
Mode |
Mnémonique |
Action |
| 37 | THRESHOLD_DRAWLINE |
Dessine ou masque le ou les seuil(s) sélectionné(s. Retour : 1 si OK, 0 sinon. 0 en cas d'erreur (Identity introuvable, ou l'instruction n'est pas supportée dans ce contexte). -1 la plume n'est pas utilisée. -2 La valeur ThresholdNumber est hors plage. -3 Aucun système de seuils n'est configuré. |
Syntaxe 27
IntVal = Trend(Mode, Window, Branch, Identity, Trace, Red, Green, Blue[, PenStyle]);
Type de retour : INTEGER.
|
Argument |
Définition |
| Red | Composant rouge de la couleur du seuil. Type INTEGER, de -1 à 255. |
| Blue | Composant bleu de la couleur du seuil. Type INTEGER, de -1 à 255. |
| Green | Composant vert de la couleur du seuil. Type INTEGER, de -1 à 255. |
| PenStyle |
Style de ligne du seuil. Facultatif. Voir tableau en Syntaxe 24. |
Exécution
|
Mode |
Mnémonique |
Action |
| 38 | DRAW_MINLINE | Affiche une ligne pour la valeur minimum de la variable. La couleur est celle de la plume au dépassement de la ligne. Si -1 est utilisé pour chaque composant de couleur, la couleur ne change pas. |
| 39 | DRAW_MAXLINE | Affiche une ligne pour la valeur maximum de la variable. La couleur est celle de la plume au dépassement de la ligne. Si -1 est utilisé pour chaque composant de couleur, la couleur ne change pas. |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 28
IntVal = Trend (MODE, Window, Branch, Identity, Trace, TimeOrigin);
Type de retour : INTEGER.
|
Argument |
Définition |
| TimeOrigin | Date d'origine de la plume (côté gauche de la trace). Type DOUBLE comme pour DATETIMEVALUE. |
Exécution
|
Mode |
Mnémonique |
Action |
| 41 | SETTIMEORIGIN |
Positionne l'origine de la plume (côté gauche) à une date spécifique. Retour : 1 si OK, sinon |
Syntaxe 29
IntVal = Trend (MODE, Window, Branch, Identity, Trace, Time, TimeUnit);
Type de retour : INTEGER.
|
Argument |
Définition |
| Time | Période en nombre d'unités de TimeUnit. Type INTEGER |
| TimeUnit | Numéro représentant l'unité de temps à utiliser. Voir tableau ci-dessous. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 42 | SETTIMEOFFSET |
Remplace l'origine de la plume (côté gauche) en utilisant les valeurs données. Retour : 1 si OK, 0 sinon. |
Unité de temps
| Valeur | Unité |
| 0 | Annule le remplacement |
| 1 | Secondes |
| 2 | Minutes |
| 3 | Heures |
| 4 | Jours |
Syntaxe 30
IntVal = Trend (MODE, Window, Branch, Identity, Trace, MinMax [, Showline]);
Type de retour : INTEGER.
|
Argument |
Définition |
| MinMax |
Paramètre indiquant la ligne à affecter. Type INTEGER -1 = Les deux lignes 1 = Ligne minimum |
| Showline | Flag pour sélectionner Masquer ou Montrer les lignes. Optionnel. Type INTEGER. 0 = Masquer 1 = Afficher - Valeur par défaut si le paramètre est omis. |
Exécution
|
Mode |
Mnémonique |
Action |
| 40 | DISPLAY_MINMAXLINE |
Affiche/masque les lignes horizontales minimales ou maximales des variables. Retour : 1 si OK, 0 sinon. |
Syntaxe 31
IntVal = TREND(Mode, Window, Branch, Identity, Trace, Flag);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Flag |
Flag indiquant l'opération à effectuer. Type INTEGER 0 = Masquer 1 = Afficher |
Exécution
|
Mode |
Mnémonique |
Action |
|
44 |
SET_VISIBLE |
Cache ou affiche la plume en fonction de la valeur de Flag. |
| 45 | DISPLAY_SCALE |
Cache ou affiche l'échelle de la plume en fonction de la valeur de Flag. |
| Retour : 1 si OK, 0 sinon. |
Syntaxe 32
DblVal = Trend(Mode, Window, Branch, Identity, Trace, ThresholdNumber);
Type de retour : DOUBLE.
|
Argument |
Définition |
| ThresholdNumber | Numéro identifiant le seuil. Type INTEGER, de 0 à 3. |
Exécution
|
Mode |
Mnémonique |
Action |
| 47 | THRESHOLD_GETVALUE |
Retour : La valeur du seuil ThresholdNumber si OK, 0 sinon. |
| 48 | THRESHOLD_ISCHECKED |
Retour : 1 si le seuil ThresholdNumber est utilisé et que la ligne horizontale correspondante est dessinée, 0 si la ligne correspondante n'est pas dessinée. |
| 49 | THRESHOLD_ISDRAWLINE |
Retour : 1 si le seuil Seuil est utilisé et que la ligne horizontale correspondante est tracée, 0 si la ligne correspondante n'est pas tracée. |
| 50 | THRESHOLD_GETCOLOR |
Retour: La couleur de la plume lorsque le seuil ThresholdNumber est dépassé. La couleur est encodée sous la forme d'une valeur RGB. |
| 51 | THRESHOLD_GETSTYLE |
Retour: Le style de la plume lorsque le seuil ThresholdNumber est dépassé. Voir tableau en Syntaxe 24. |
|
Retour: 0 en cas d'erreur (Identity introuvable, ou l'instruction n'est pas supportée dans ce contexte). -1 la plume n'est pas utilisée. -2 La valeur ThresholdNumber est hors plage. -3 Aucun système de seuils n'est configuré. |
Syntaxe 33
IntVal = Trend(Mode, Window, Branch, Identity, Show);
Type de retour : INTEGER.
|
Argument |
Définition |
| Show |
Flag indiquant l'opération à effectuer. Type INTEGER 0 = Masquer 1 = Afficher |
Exécution
|
Mode |
Mnémonique |
Action |
| 52 | SHOW_LEGEND |
Cache ou affiche la légende en fonction de la valeur de Flag. Retour : 1 si OK, -1 si Show est hors plage, 0 sinon. |
Syntaxe 34
IntVal = TREND( Mode, Window, Branch, Identity[, Filename]);
Type de retour : INTEGER.
|
Argument |
Définition |
| Filename | Soit le nom absolu d'un fichier, soit un nom de fichier relatif au dossier TP du projet. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
|
54 |
GETCONFIG |
Retourne la configuration d'une fenêtre de tendance au format Xml et la charge dans un namespace ou génére un fichier Xml si Filename est fourni. Le namespace créé en mémoire est : Branch.Window.Identity |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 35
IntVal = TREND( Mode, Window, Branch, Identity, Handle);
Type de retour : INTEGER.
|
Argument |
Définition |
| Handle | Handle du buffer contenant la configuration Xml de la fenêtre de tendance. Type LONG. |
Exécution
|
Mode |
Mnémonique |
Action |
|
55 |
SETCONFIG |
Modifie la configuration d'une fenêtre de tendance en utilisant la configuration Xml stockée dans le buffer Handle. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 36
IntVal = TREND( Mode,Window, Branch,Identity,Filename[, Program[, ProgramBranch [, Function[, Argument]]]] );
Type de retour : INTEGER.
|
Argument |
Définition |
| Filename | Soit le nom absolu d'un fichier, soit un nom de fichier relatif au dossier TP du projet. Type STR. Si Filename n'est pas défini, aucun fichier Xml n'est généré, bien que la fonction callback puisse toujours être exécutée. |
| Program | Nom du programme pour la fonction callback. |
| ProgramBranch | Branche du programme de la fonction callback. |
| Function | Nom de la fonction callback. |
| Argument | Arguments de la fonction callback. |
|
Si aucune fonction callback n'est définie, la fonction callback facultative sera par défaut :
Si aucune fonction n'est définie, assurez-vous que la fonction onTrend_GetConfig est définie même si elle est vide. Sinon, la fonction peut toujours aboutir mais avec un message d'erreur. |
Exécution
|
Mode |
Mnémonique |
Action |
|
56 |
GETCONFIG_ASYNC |
Utilisé pour faire un appel asynchrone (typiquement depuis un client WebVue) afin de récupérer la configuration courante d'une fenêtre de tendance dans un format Xml et générer un fichier Xml si le paramètre Filename est passé. GETCONFIG_ASYNC dans WebVue correspond au mode GETCONFIG dans le client desktop du logiciel PcVue. Le mode asynchrone est utilisé pour le client WebVue avec une fonction callback optionnelle. |
|
|
|
Retour : 1 si OK. Notez que, comme la fonction est asynchrone, 1 sera renvoyé même s'il y a des problèmes avec la fonction callback (comme un nom de fonction callbak incorrect) 0 est retourné si l'un des arguments est incorrect ou si la fonction échoue. |
Syntaxe 37
IntVal = TREND( Mode, Window, Branch, Identity, Save );
Type de retour : INTEGER.
|
Argument |
Définition |
|
Save |
Flag pour activer (1) ou désactiver (0) l'option. |
Exécution
|
Mode |
Mnémonique |
Action |
|
57 |
SETSAVERUNTIMEPROPS |
Active ou désactive la possibilité de sauvegarder les propriétés d'exploitation d'une fenêtre de tendance. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Exemple
Pour un exemple, sélectionner le lien Exemple ci-dessus.