Langage de script pour la configuration de la substitution

Les scripts Ruby sont écrits pour définir quand les objets de substitution doivent être utilisés en fonction des données météo et de la date.

Vous trouverez un exemple de script ci-dessous :

Les noms de classe et les fonctions de membres suivants sont actuellement implémentés :

Classe IWLCalendar

Cette classe est destinée à un usage général.

L’état d’une date (qu’il s’agisse d’un week-end, d’un jour de semaine ou d’un jour férié) peut être défini dans l’onglet Calendrier d’un objet Données météo pour IWLive.

Si aucun calendrier n’est défini (aucun contrôleur de substitution associé à la référence de base), un calendrier par défaut est utilisé lors de l’exécution du script. Le calendrier par défaut ne comporte pas de jours fériés et a une période de fin de semaine est définie sur le samedi et le dimanche.

Fonction de membre Description
bool is_holiday()

Renvoie la valeur true si la date de prévision actuelle correspond à un jour férié (tel que défini par le calendrier)

bool is_holiday(string name)

Renvoie true si la date de prévision actuelle correspond au jour férié nommé (tel que défini par le calendrier)

bool is_weekday()

Renvoie true si la date de prévision actuelle est un jour de la semaine (tel que défini par le calendrier)

bool is_weekend()

Renvoie true si la date de prévision actuelle est un week-end (tel que défini par le calendrier)

to_time

Renvoie un objet Ruby.Time pour la date de prévision actuelle. Pour en savoir plus sur l’utilisation du type de temps Ruby, veuillez suivre ce lien.

Remarque : la valeur donnée par IWLCalendar.to_time est initialisée à minuit le jour de l’exécution, de sorte que seules les valeurs de date peuvent être examinées de manière significative (c’est-à-dire que l’heure et la minute sont toujours égales à 0). Cela signifie que la valeur de IWLCalendar.to_time est en fait la date de début de l’exécution.

Par exemple, pour basculer entre les jours de la semaine, utilisez wday() (dimanche = 0 ; samedi = 6) ; pour basculer entre les mois, utilisez mon() (janvier = 1 ; décembre = 12).

NB : la date de prévision a un état unique. En d’autres termes, la date ne peut prendre que l’une des valeurs suivantes : jour férié, jour de la semaine ou week-end.

Classe IWLBaseline

Cette classe est destinée à un usage général.

Fonction de membre Description
switch(type, id)

Définit le type* et l’ID de l’objet de modèle spécifié comme objet de substitution.

switch(type, name)

Définit le type* et le nom de l’objet de modèle spécifié comme objet de substitution.

switch(type, guid)

Définit le type* et le GUID de l’objet de modèle spécifié comme objet de substitution.

L’ID, le nom et le GUID d’un objet peuvent être affichés en cliquant avec le bouton droit de la souris sur l’objet de base de données dans l’arborescence de la fenêtre du groupe de modèles, puis en sélectionnant Propriétés dans le menu contextuel.

* L’argument type est le nom du type de script. Dans la plupart des cas, il est identique à la description de l’objet de modèle :

Argument type Description de l’objet

Contrôle

Contrôle

Diagramme de la demande

Diagramme de la demande

Ajustement de la demande

Ajustement de la demande

Tarif de l’électricité

Tarif de l’électricité

Facteurs d’énergie GES

Facteurs CO2 d’énergie

Scénario RTC

Scénario CPU

Classe UKMetOfficeWCF

Cette classe est utilisée pour les prévisions sur cinq jours dans les villes du monde réalisées par le service britannique de météorologie Met Office

Fonction de membre Description

double weather_code()

Renvoie un code météo.

Consultez le site du Met Office pour obtenir de la documentation permettent d’interpréter les codes météorologiques.

double max_temperature()

Renvoie la température maximale prévue pour la prévision actuelle.

double max_temperature()

Renvoie la température minimale prévue pour la prévision actuelle.

Classe UKMetOfficeDWF

Cette classe est utilisée pour les prévisions dans les villes britanniques et dans les villes du monde réalisées par le service britannique de météorologie Met Office.

Fonction de membre Description

double day_weather_code()

Renvoie un code météo décrivant les conditions météorologiques significatives de la journée pour la prévision en cours.

double night_weather_code()

Renvoie un code météo décrivant les conditions météorologiques significatives de la nuit pour la prévision en cours.

double max_temperature()

Renvoie la température maximale prévue pour la prévision actuelle.

double mix_temperature()

Renvoie la température minimale prévue pour la prévision actuelle.