Fonctions globales et constantes

Packages - Hiérarchie - Index



Aperçu des constantes


_G_ Constante gravitationnelle (en N.
_N_ Nombre d'Avogadro (en molecules/mole)
_R_ Constante universelle des gaz (en J/mole.
_V0_ Volume molaire à TPN (en litres/mole)
_c_ Vitesse de la lumière dans le vide (en m/s)
_e_ La constante e, telle que ln(e) = 1
_el_ Charge d'un électron (en C)
_eps0_ Permittivité du vide (en C2/N.
_g_ Pesanteur à la surface de la Terre (en m/s2)
_h_ Constante de Planck (en J.
_kB_ Constante de Boltzmann (en J/K)
_kC_ Constante de Coulomb (en N.
_mu0_ Perméabilité du vide (en T.
_pi_ La constante Pi
_sigma_ Constante de Stefan-Boltzmann (en W/m2.
false Valeur booléenne fausse.
randomPicking Mode aléatoire de désignation des agents.
serialPicking Mode ordonné de désignation des agents.
true Valeur booléenne vraie.


Aperçu des fonctions globales


abort Arrete définitivement le thread spécifié.
abs Calcule la valeur absolue d'un réel.
acos Calcule l'arc-cosinus d'un réel.
asciiChar Obtient le caractère correspondant au code ASCII spécifié.
asciiCode Obtient le code ASCII d'un caractère.
asin Calcule l'arc-sinus d'un réel.
atan Calcule l'arc-tangente d'un réel.
betweenPi Recadre le réel dans l'intervalle ]-pi, +pi], en lui enlevant ou ajoutant un multiple de pi.
binaryString Obtient la représentation binaire de l'entier spécifié.
callProlog Lance l'interpréteur Prolog installé sur la machine, et exécute le prédicat spécifié.
callScheme Lance l'interpréteur Scheme installé sur la machine et exécute la commande spécifiée.
cartToAngle Calcule l'angle en coordonnées polaires du point défini par ses coordonnées cartésiennes.
cartToDist Calcule la distance en coordonnées polaires du point défini par ses coordonnées cartésiennes.
cartToPol Calcule la distance et l'angle en coordonnées polaires du point défini par ses coordonnées cartésiennes.
cartToSphere Calcule les coordonnées sphériques du point défini par ses coordonnées cartésiennes.
ceil Calcule l'entier le plus proche du réel qui lui soit supérieur (arrondi par excès).
commandLine Obtient la ligne de commande utilisée lors du lancement d'oRis.
control Exécute la commande interne au controleur oRis spécifiée.
cos Calcule le cosinus d'un réel.
cosh Calcule le cosinus hyperbolique d'un réel.
create Crée un nouvel objet en mémoire.
currentExecution Obtient l'identificateur du thread d'exécution courant.
defineMapClass Permet de déclarer un nouveau type de dictionnaire.
defineSetClass Permet de déclarer un nouveau type d'ensemble.
defineStackClass Permet de déclarer un nouveau type de pile.
defineVectorClass Permet de déclarer un nouveau type de vecteur.
error Affiche la pile d'exécution du thread courant, puis un message d'erreur spécifié, et enfin stoppe le thread courant.
eval Interprète dynamiquement du code source oRis.
exist Indique si un objet existe déjà dans la simulation ou non.
exp Calcule l'exponentielle d'un réel.
floor Calcule l'entier le plus proche du réel qui lui soit inférieur (arrondi par défaut).
format Formatte une chaine.
getAll Obtient toutes les instances d'une classe et de ses classes dérivées.
getClasses Obtient la liste des noms de toutes les classes déclarées dans la simulation.
getClock Obtient la valeur courante de l'horloge interne d'oRis.
getExecutionStack Retourne la pile d'instruction oRis courante pour le thread spécifié.
getHostName Obtient l'alias de la machine sur laquelle oRis est lancé.
getIPAddress Obtient l'adresse IP d'une machine connue par son seul alias.
getInterval Obtient le type de multi-tache actuellement sélectionné.
getMaxDepth Obtient le nombre de récursions ou de rebouclages maximum autorisé par oRis avant de générer une erreur de dépassement de pile interne.
getObject Obtient l'instance de l'objet désigné par son nom.
getPickingMode Obtient le mode de désignation actuel des agents.
getTime Obtient l'heure courante du système.
guiMargin Obtient la valeur standard des espacements inter-composants.
guiScreenHeight Obtient la hauteur de l'écran en pixels.
guiScreenWidth Obtient la largeur de l'écran en pixels.
guiTextHeight Obtient la hauteur moyenne d'une ligne de texte en pixels.
guiTextWidth Obtient la largeur exacte d'une ligne de texte en pixels.
hexaString Obtient la représentation hexadécimale de l'entier spécifié.
isSuspended Obtient le statut du thread spécifié :
ln Calcule le logarithme népérien d'un réel.
load Charge et interprète un fichier contenant du code source oRis.
loadLibrary Charge en mémoire la librairie dynamique spécifiée.
locateFile Obtient le nom absolu du fichier spécifié ;
log Calcule le logarithme à base 10 d'un réel.
numberOf Obtient le nombre d'instances existantes de la classe spécifiée et de ses classes dérivées.
octalString Obtient la représentation octale de l'entier spécifié.
parse Interprète dynamiquement du code source oRis.
polToCart Calcule les coordonnées cartésiennes du point défini par ses coordonnées polaires.
polToX Calcule l'abscisse en coordonnées cartésiennes du point défini par ses coordonnées polaires.
polToY Calcule l'ordonnée en coordonnées cartésiennes du point défini par ses coordonnées polaires.
pow Calcule le résultat d'un réel puissance un autre.
print Affiche un message sur le flux standard de sortie (généralement la console depuis laquelle oRis est lancé).
printStack Affiche à l'écran la pile d'instructions oRis en cours dans le thread courant.
println Affiche un message sur le flux standard de sortie (généralement la console depuis laquelle oRis est lancé), puis un retour à la ligne.
readln Attend que l'utilisateur entre du texte à l'aide du clavier.
resume Réactive le thread spécifié, précédemment stoppé par la fonction suspend().
save Sauvegarde l'état de tous les objets de la simulation dans un fichier.
setClock Réinitialise la valeur courante de l'horloge interne d'oRis à une valeur spécifiée.
setInterval Indique le type de multi-tache à prendre en compte.
setMaxDepth Indique le nombre de récursions ou de rebouclages maximum autorisé par oRis avant de générer une erreur de dépassement de pile interne.
setPickingMode Indique le mode de désignation des agents à prendre en compte.
showURL Lance le navigateur HTML par défaut de la machine, et affiche un document Internet.
signedSqrt Calcule la racine carrée d'un réel, et préfixe le résultat du meme signe que le réel lui-meme.
signedSquare Calcule le carré d'un réel, et préfixe le résultat du meme signe que le réel lui-meme.
sin Calcule le sinus d'un réel.
sinh Calcule le sinus hyperbolique d'un réel.
sphereToCart Calcule les coordonnées cartésiennes du point défini par ses coordonnées sphériques.
sqrt Calcule la racine carrée d'un réel.
square Calcule le carré d'un réel.
suspend Arrete temporairement le thread spécifié.
system Exécute une commande système en aveugle, c'est à dire sans fournir de données supplémentaires particulières à cette commande, et sans lire les données présentes dans le flux de sortie ou d'erreur après l'exécution de cette commande.
systemE Exécute une commande système sans fournir de données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux d'erreur uniquement de cette commande.
systemI Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, mais sans lire les données présentes dans le flux de sortie ou d'erreur de cette commande.
systemIE Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux d'erreur uniquement de cette commande.
systemIO Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux de sortie uniquement de cette commande.
systemIOE Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans les flux de sortie et d'erreur de cette commande.
systemName Obtient une chaine identifiant le système d'exploitation courant.
systemO Exécute une commande système sans fournir de données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux de sortie uniquement de cette commande.
systemOE Exécute une commande système sans fournir de données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans les flux de sortie et d'erreur de cette commande.
tan Calcule la tangente d'un réel.
tanh Calcule la tangente hyperbolique d'un réel.
warning Affiche la pile d'exécution du thread courant, puis un message d'avertissement spécifié, et poursuit l'exécution du thread courant.
yield Force le changement de contexte courant et active la tache suivante.


Référence des constantes


_G_

replace _G_ by 6.67e-11;

Constante gravitationnelle (en N.m2/kg2)

_N_

replace _N_ by 6.023e23;

Nombre d'Avogadro (en molecules/mole)

_R_

replace _R_ by 8.31e3;

Constante universelle des gaz (en J/mole.K)

_V0_

replace _V0_ by 22.4;

Volume molaire à TPN (en litres/mole)

_c_

replace _c_ by 3e8;

Vitesse de la lumière dans le vide (en m/s)

_e_

replace _e_ by 2.7182818284590452354;

La constante e, telle que ln(e) = 1

_el_

replace _el_ by 1.6e-19;

Charge d'un électron (en C)

_eps0_

replace _eps0_ by 8.85e-12;

Permittivité du vide (en C2/N.m2)

_g_

replace _g_ by 9.81;

Pesanteur à la surface de la Terre (en m/s2)

_h_

replace _h_ by 6.63e-34;

Constante de Planck (en J.s)

_kB_

replace _kB_ by 1.38e-23;

Constante de Boltzmann (en J/K)

_kC_

replace _kC_ by 8.99e9;

Constante de Coulomb (en N.m2/C2)

_mu0_

replace _mu0_ by 12.566e-7;

Perméabilité du vide (en T.m/A)

_pi_

replace _pi_ by 3.14159265358979323846;

La constante Pi

_sigma_

replace _sigma_ by 5.67e-8;

Constante de Stefan-Boltzmann (en W/m2.K4)

false

replace false by 0;

Valeur booléenne fausse.

randomPicking

replace randomPicking by 0;

Mode aléatoire de désignation des agents.

Voir aussi
setPickingMode

serialPicking

replace serialPicking by 1;

Mode ordonné de désignation des agents.

Voir aussi
setPickingMode

true

replace true by 1;

Valeur booléenne vraie.


Référence des fonctions globales


abort

native void abort(int execution);

Arrete définitivement le thread spécifié.

Paramètres
execution - l'identificateur du thread à stopper

abs

float abs(float x);

Calcule la valeur absolue d'un réel.

Paramètres
x - un réel
Valeur de retour
la valeur absolue de x

acos

float acos(float x);

Calcule l'arc-cosinus d'un réel.

Paramètres
x - un réel
Valeur de retour
l'arc-cosinus de x

asciiChar

native string asciiChar(int code);

Obtient le caractère correspondant au code ASCII spécifié.

Paramètres
code - le code ASCII dont on veut le caractère associé
Valeur de retour
le caractère correspondant au code ASCII code
Voir aussi
asciiCode

asciiCode

native int asciiCode(string char);

Obtient le code ASCII d'un caractère.

Paramètres
char - le caractère dont on veut le code ASCII
Valeur de retour
le code ASCII du premier caractère de la chaine char
Voir aussi
asciiChar

asin

float asin(float x);

Calcule l'arc-sinus d'un réel.

Paramètres
x - un réel
Valeur de retour
l'arc-sinus de x

atan

float atan(float x);

Calcule l'arc-tangente d'un réel.

Paramètres
x - un réel
Valeur de retour
l'arc-tangente de x

betweenPi

float betweenPi(float a);

Recadre le réel dans l'intervalle ]-pi, +pi], en lui enlevant ou ajoutant un multiple de pi.

Paramètres
a - un réel
Valeur de retour
le réel compris entre ]-pi, +pi]

binaryString

native string binaryString(int value);

Obtient la représentation binaire de l'entier spécifié.

Paramètres
value - l'entier à convertir
Valeur de retour
la valeur binaire correspondante (sur 32 digits obligatoirement).
Voir aussi
hexaString, octalString

callProlog

void callProlog(string goal);

Lance l'interpréteur Prolog installé sur la machine, et exécute le prédicat spécifié.

Paramètres
goal - le prédicat à interpréter

callScheme

void callScheme(string command);

Lance l'interpréteur Scheme installé sur la machine et exécute la commande spécifiée.

Paramètres
command - commande à exécuter

cartToAngle

float cartToAngle(float x, float y);

Calcule l'angle en coordonnées polaires du point défini par ses coordonnées cartésiennes.

Paramètres
x - l'abscisse cartésienne du point
y - l'ordonnée cartésienne du point
Valeur de retour
l'angle en coordonnées polaires, ou 0 si x et y sont nuls

cartToDist

float cartToDist(float x, float y);

Calcule la distance en coordonnées polaires du point défini par ses coordonnées cartésiennes.

Paramètres
x - l'abscisse cartésienne du point
y - l'ordonnée cartésienne du point
Valeur de retour
la distance en coordonnées polaires

cartToPol

void cartToPol(float & d, float & a, float x, float y);

Calcule la distance et l'angle en coordonnées polaires du point défini par ses coordonnées cartésiennes.

Paramètres
d - la distance polaire résultat
a - l'angle polaire résultat
x - l'abscisse cartésienne du point
y - l'ordonnée cartésienne du point

cartToSphere

void cartToSphere(float & d, float & xyAngle, float & zAngle, float x, float y, float z);

Calcule les coordonnées sphériques du point défini par ses coordonnées cartésiennes.

Paramètres
d - la distance sphérique résultat
xyAngle - l'angle xy sphérique résultat
zAngle - l'angle z sphérique résultat
x - l'abscisse cartésienne du point
y - l'ordonnée cartésienne du point
z - la cote cartésienne du point

ceil

float ceil(float x);

Calcule l'entier le plus proche du réel qui lui soit supérieur (arrondi par excès).

Paramètres
x - un réel
Valeur de retour
l'arrondi par excès de x

commandLine

native string[] commandLine(bool full);

Obtient la ligne de commande utilisée lors du lancement d'oRis.

Paramètres
full - si la valeur true est utilisée, alors tous les arguments y compris le mot "oris" et l'option de lancement d'oRis en mode texte ou graphique seront renvoyés. Dans le cas contraire, seul le nom éventuel du script chargé au démarrage d'oRis et les options spécifiques à l'utilisateur et non reconnues par oRis seront renvoyées.
Valeur de retour
les mots constituant la ligne de commande

control

native string control(string command, string argument);

Exécute la commande interne au controleur oRis spécifiée. Si besoin est, un ou plusieurs arguments peuvent etre transmis.

Cette méthode n'est publique que pour des besoins internes. Elle ne devrait pas etre appelée directement depuis le code oRis. A la place, la classe OrisControl devrait etre utilisée.

Paramètres
command - la commande interne à exécuter
argument - les arguments optionnels à transmettre
Valeur de retour
la valeur de retour éventuelle de la fonction interne
Voir aussi
OrisControl

cos

float cos(float x);

Calcule le cosinus d'un réel.

Paramètres
x - un réel
Valeur de retour
le cosinus de x

cosh

float cosh(float x);

Calcule le cosinus hyperbolique d'un réel.

Paramètres
x - un réel
Valeur de retour
le cosinus hyperbolique de x

create

native Object create(string objName);

Crée un nouvel objet en mémoire. Le nom de ce nouvel objet sera celui spécifié dans l'appel de cette fonction.

Attention : le constructeur de l'objet nouvellement créé n'est pas appelé, et donc doit l'etre explicitement après la création de l'instance !

Paramètres
objName - le nom de l'objet à créer (de type classe.numéro_d'instance)
Valeur de retour
le nouvel objet, ou NONE si un objet possèdant déjà le nom spécifié existe

currentExecution

native int currentExecution();

Obtient l'identificateur du thread d'exécution courant.

Valeur de retour
l'identificateur

defineMapClass

string defineMapClass(string keyType, string elemType, string className);

Permet de déclarer un nouveau type de dictionnaire.

L'appel de cette méthode provoque la création d'une nouvelle classe dérivant de la classe Map. Pour créer un dictionnaire d'objets d'un type particulier associés à des clés d'un autre type, il suffit d'instancier la classe générée par cette méthode.

Exemple :
// Crée un dictionnaire clé string - valeur Agent
defineMapClass("string", "Agent", "Population");
Population pop = new Population();
pop->setElem("agent1", new Agent());
...

Paramètres
keyType - le type de base des clés du dictionnaire
elemType - le type de base des objets du dictionnaire
className - le nom de la classe à instancier pour créer un dictionnaire ayant des clés et des valeurs de type spécifié
Valeur de retour
?

defineSetClass

string defineSetClass(string elemType, string className);

Permet de déclarer un nouveau type d'ensemble.

L'appel de cette méthode provoque la création d'une nouvelle classe dérivant de la classe Set. Pour créer un ensemble d'objets d'un type particulier, il suffit d'instancier la classe générée par cette méthode.

Exemple :
// Crée un ensemble d'Agent
defineMapClass("Agent", "Population");
Population pop = new Population();
pop->setElem(new Agent());
...

Paramètres
elemType - le type de base des objets de l'ensemble
className - le nom de la classe à instancier pour créer un ensemble ayant des valeurs de type spécifié
Valeur de retour
?

defineStackClass

string defineStackClass(string elemType, string className);

Permet de déclarer un nouveau type de pile.

L'appel de cette méthode provoque la création d'une nouvelle classe dérivant de la classe Stack. Pour créer une pile d'objets d'un type particulier, il suffit d'instancier la classe générée par cette méthode.

Exemple :
// Crée une pile de string
defineStackClass("string", "PileDeChaines");
PileDeChaines maPile = new PileDeChaines();
maPile->push("chaine de test");
...

Paramètres
elemType - le type de base des objets de la pile
className - le nom de la classe à instancier pour créer une pile de type spécifié
Valeur de retour
?

defineVectorClass

string defineVectorClass(string elemType, string className);

Permet de déclarer un nouveau type de vecteur.

L'appel de cette méthode provoque la création d'une nouvelle classe dérivant de la classe Vector. Pour créer un vecteur d'objets d'un type particulier, il suffit d'instancier la classe générée par cette méthode.

Exemple :
// Crée un vecteur de string
defineVectorClass("string", "TableauDeChaines");
TableauDeChaines monTableau = new TableauDeChaines();
monTableau->pushBack("chaine de test");
...

Paramètres
elemType - le type de base des objets du vecteur
className - le nom de la classe à instancier pour créer un vecteur de type spécifié
Valeur de retour
?

error

void error(type1 value1, type2 value2, ... ...);

Affiche la pile d'exécution du thread courant, puis un message d'erreur spécifié, et enfin stoppe le thread courant.

Paramètres
value1 - le texte de l'erreur à afficher (peut etre de n'importe quel type de données)
value2 - le texte de l'erreur à afficher (peut etre de n'importe quel type de données)
... - ...

eval

native int eval(string code);

Interprète dynamiquement du code source oRis. Si un ou plusieurs blocs execute sont présent dans le code à interpréter, ceux-ci seront exécutés dans l'ordre de leur déclaration, et à partir du début du cycle de simulation suivant.

L'interprétation se fait dans le contexte d'exécution courant ; cela signifie que le code interprété peut référencer n'importe quel objet ou variable existant dans le contexte courant.

Paramètres
code - le code source à interpréter
Valeur de retour
le nombre d'erreurs étant survenues lors de l'interprétation
Voir aussi
parse

exist

native bool exist(Object obj);

Indique si un objet existe déjà dans la simulation ou non.

Paramètres
obj - l'objet à tester
Valeur de retour
true si l'instance existe déjà, false sinon

exp

float exp(float x);

Calcule l'exponentielle d'un réel.

Paramètres
x - un réel
Valeur de retour
l'exponentielle de x

floor

float floor(float x);

Calcule l'entier le plus proche du réel qui lui soit inférieur (arrondi par défaut).

Paramètres
x - un réel
Valeur de retour
l'arrondi par défaut de x

format

string format(type1 value1, type2 value2, type3 ...);

Formatte une chaine.

Paramètres
value1 - un élément de texte (peut etre de n'importe quel type de données)
value2 - un élément de texte (peut etre de n'importe quel type de données)
... - ...
Valeur de retour
une chaine contenant tous les arguments transformés en chaine de caractères et concaténés entre eux

getAll

native Object[] getAll(string className);

Obtient toutes les instances d'une classe et de ses classes dérivées.

Paramètres
className - le nom de la classe dont on veut obtenir les instances, ou une chaine vide pour obtenir tous les objets de la simulation
Valeur de retour
les instances, ou un tableau vide si le nom de classe spécifié n'est pas valide

getClasses

native string[] getClasses();

Obtient la liste des noms de toutes les classes déclarées dans la simulation.

Valeur de retour
la liste des noms de toutes les classes

getClock

native int getClock();

Obtient la valeur courante de l'horloge interne d'oRis.

Valeur de retour
la valeur courante de l'horloge

getExecutionStack

native void getExecutionStack(Object[] & callers, string[] & modules, int execution);

Retourne la pile d'instruction oRis courante pour le thread spécifié.

Paramètres
callers - la liste des instances activée
modules - la liste des méthodes des instances en cours d'exécution
execution - l'identificateur du thread concerné
Voir aussi
printStack

getHostName

string getHostName();

Obtient l'alias de la machine sur laquelle oRis est lancé.

Valeur de retour
l'alias de la machine

getIPAddress

string getIPAddress(string hostName);

Obtient l'adresse IP d'une machine connue par son seul alias.

Paramètres
hostName - l'alias d'une machine
Valeur de retour
l'adresse IP de la machine spécifiée

getInterval

native int getInterval();

Obtient le type de multi-tache actuellement sélectionné.

Le multi-tache préemptif est sélectionné si la valeur de l'intervalle est positive ; cela implique que le changement de contexte se fera toutes les n millisecondes, n étant la valeur de l'intervalle.

Le multi-tache coopératif est sélectionné si la valeur de l'intervalle est nulle ; cela implique que le changement de contexte se fera lors d'une demande explicite (appel de la méthode yield(), fin de la méthode main(), attente de ressources, ...).

Le multi-tache profondément parallèle est sélectionné si la valeur de l'intervalle est égale à -1 ; cela implique que le changement de contexte se fera après chaque micro-instruction oRis.

Valeur de retour
une valeur positive pour le multi-tache préemptif, nulle pour le multi-tache coopératif, et -1 pour le multi-tache profondément parallèle
Voir aussi
setInterval, yield

getMaxDepth

native int getMaxDepth();

Obtient le nombre de récursions ou de rebouclages maximum autorisé par oRis avant de générer une erreur de dépassement de pile interne.

Valeur de retour
le nombre maximum de boucles ou de récursions permises
Voir aussi
setMaxDepth

getObject

native Object getObject(string objName);

Obtient l'instance de l'objet désigné par son nom.

Paramètres
objName - le nom de l'objet à récupérer
Valeur de retour
l'instance correspondant au nom, ou NONE si l'instance n'existe pas

getPickingMode

native int getPickingMode();

Obtient le mode de désignation actuel des agents.

La désignation aléatoire implique qu'à chaque cycle oRis, les méthodes main() des agents sont exécutées dans un ordre aléatoire, permettant de ne pas privilégier certains agents au détriment d'autres.

La désignation ordonnée au contraire implique qu'à chaque cycle oRis, les méthodes main() des agents sont exécutées toujours dans le meme ordre.

Valeur de retour
la constante randomPicking (désignation aléatoire) ou serialPicking (désignation ordonnée)
Voir aussi
randomPicking, serialPicking, setPickingMode

getTime

native int getTime();

Obtient l'heure courante du système.

Valeur de retour
l'heure courante, en millisecondes

guiMargin

int guiMargin();

Obtient la valeur standard des espacements inter-composants.

Valeur de retour
l'espacement entre les composants en pixels

guiScreenHeight

int guiScreenHeight();

Obtient la hauteur de l'écran en pixels.

Valeur de retour
la hauteur de l'écran

guiScreenWidth

int guiScreenWidth();

Obtient la largeur de l'écran en pixels.

Valeur de retour
la largeur de l'écran

guiTextHeight

int guiTextHeight();

Obtient la hauteur moyenne d'une ligne de texte en pixels.

Valeur de retour
la hauteur moyenne, dépendant de la police de caractères utilisée

guiTextWidth

int guiTextWidth(string text);

Obtient la largeur exacte d'une ligne de texte en pixels.

Paramètres
text - la ligne de texte dont on veut la largeur
Valeur de retour
la largeur, dépendant de la police de caractères utilisée

hexaString

native string hexaString(int value);

Obtient la représentation hexadécimale de l'entier spécifié.

Paramètres
value - l'entier à convertir
Valeur de retour
la valeur hexadécimale correspondante, débarassée des 0 non significatifs
Voir aussi
octalString, binaryString

isSuspended

native bool isSuspended(int execution);

Obtient le statut du thread spécifié : en cours d'exécution, ou stoppé.

Paramètres
execution - l'identificateur du thread
Valeur de retour
true si le thread est suspendu, false s'il est en cours d'exécution
Voir aussi
suspend, resume, abort

ln

float ln(float x);

Calcule le logarithme népérien d'un réel.

Paramètres
x - un réel, supérieur strictement à zéro
Valeur de retour
le logarithme népérien de x

load

native int load(string fileName);

Charge et interprète un fichier contenant du code source oRis. Si un ou plusieurs blocs execute sont présent dans le code à interpréter, ceux-ci seront exécutés dans l'ordre de leur déclaration, et à partir du début du cycle de simulation suivant.

Si le nom de fichier ne contient pas de nom de répertoire, La recherche de ce fichier commence à partir du chemin courant (celui à partir duquel oRis a été lancé), puis se poursuit le cas échéant dans les répertoires précisés dans la variable d'environnement ORISPATH.

Paramètres
fileName - le nom du fichier à ouvrir et à interpréter
Valeur de retour
le nombre d'erreurs étant survenues lors de l'interprétation
Voir aussi
save

loadLibrary

native bool loadLibrary(string libName);

Charge en mémoire la librairie dynamique spécifiée.

Paramètres
libName - le nom du fichier à charger
Valeur de retour
true si la librairie s'est correctement chargée, false dans le cas contraire

locateFile

native string locateFile(string fileName);

Obtient le nom absolu du fichier spécifié ; la recherche du fichier, s'il n'est pas référencé par rapport à un répertoire, se fait d'abord dans le répertoire courant (celui à partir duquel oRis a été lancé), puis le cas échéant dans chacun des répertoires référencés dans la variable d'environnement ORISPATH.

Paramètres
fileName - le fichier à rechercher
Valeur de retour
le nom absolu du fichier

log

float log(float x);

Calcule le logarithme à base 10 d'un réel.

Paramètres
x - un réel, supérieur strictement à zéro
Valeur de retour
le logarithme à base 10 de x

numberOf

native int numberOf(string className);

Obtient le nombre d'instances existantes de la classe spécifiée et de ses classes dérivées.

Paramètres
className - le nom de la classe dont on veut obtenir le nombre d'instances, ou une chaine vide pour recenser tous les objets de la simulation
Valeur de retour
le nombre d'instances, ou -1 si le nom de classe spécifié n'est pas valide

octalString

native string octalString(int value);

Obtient la représentation octale de l'entier spécifié.

Paramètres
value - l'entier à convertir
Valeur de retour
la valeur octale correspondante, débarassée des 0 non significatifs
Voir aussi
hexaString, binaryString

parse

native int parse(string program);

Interprète dynamiquement du code source oRis. Si un ou plusieurs blocs execute sont présent dans le code à interpréter, ceux-ci seront exécutés dans l'ordre de leur déclaration, et à partir du début du cycle de simulation suivant.

L'interprétation se fait hors contexte d'exécution courant ; cela signifie que le code interprété ne peut pas référencer les objets ou variables existant dans le contexte courant. En effet, ces élements ne sont pas déclarés dans le contexte de l'interprétation.

Paramètres
program - le code source à interpréter
Valeur de retour
le nombre d'erreurs étant survenues lors de l'interprétation
Voir aussi
eval

polToCart

void polToCart(float & x, float & y, float d, float a);

Calcule les coordonnées cartésiennes du point défini par ses coordonnées polaires.

Paramètres
x - l'abscisse cartésienne résultat
y - l'ordonnée cartésienne résultat
d - la distance polaire du point
a - l'angle polaire du point

polToX

float polToX(float d, float a);

Calcule l'abscisse en coordonnées cartésiennes du point défini par ses coordonnées polaires.

Paramètres
d - la distance polaire du point
a - l'angle polaire du point
Valeur de retour
l'abscisse en coordonnées cartésiennes

polToY

float polToY(float d, float a);

Calcule l'ordonnée en coordonnées cartésiennes du point défini par ses coordonnées polaires.

Paramètres
d - la distance polaire du point
a - l'angle polaire du point
Valeur de retour
l'ordonnée en coordonnées cartésiennes

pow

float pow(float x, float y);

Calcule le résultat d'un réel puissance un autre.

Paramètres
x - le nombre de base
y - la puissance
Valeur de retour
x à la puissance y

print

void print(type1 value1, type2 value2, type3 ...);

Affiche un message sur le flux standard de sortie (généralement la console depuis laquelle oRis est lancé).

Paramètres
value1 - le texte à afficher (peut etre de n'importe quel type de données)
value2 - le texte à afficher (peut etre de n'importe quel type de données)
... - ...

printStack

native void printStack();

Affiche à l'écran la pile d'instructions oRis en cours dans le thread courant.

Voir aussi
getExecutionStack

println

void println(type1 value1, type2 value2, ... ...);

Affiche un message sur le flux standard de sortie (généralement la console depuis laquelle oRis est lancé), puis un retour à la ligne.

Paramètres
value1 - le texte à afficher (peut etre de n'importe quel type de données)
value2 - le texte à afficher (peut etre de n'importe quel type de données)
... - ...

readln

native string readln();

Attend que l'utilisateur entre du texte à l'aide du clavier. Cette fonction est bloquante, jusqu'à ce que l'utilisateur valide son entrée par la touche ENTREE. Le texte doit etre entré via le flux d'entrée d'oRis (généralement la console système à partir de laquelle oRis a été lancé).

Valeur de retour
le texte saisi par l'utilisateur

resume

native void resume(int execution);

Réactive le thread spécifié, précédemment stoppé par la fonction suspend(). Il reprend son exécution à l'endroit meme ou il avait été stoppé.

Paramètres
execution - l'identificateur du thread à réactiver
Voir aussi
suspend

save

native void save(string fileName);

Sauvegarde l'état de tous les objets de la simulation dans un fichier.

Paramètres
fileName - le nom du fichier de sauvegarde
Voir aussi
load

setClock

native void setClock(int clk);

Réinitialise la valeur courante de l'horloge interne d'oRis à une valeur spécifiée.

Paramètres
clk - la nouvelle valeur de l'horloge

setInterval

native void setInterval(int interval);

Indique le type de multi-tache à prendre en compte.

Le multi-tache préemptif est sélectionné si la valeur de l'intervalle est positive ; cela implique que le changement de contexte se fera toutes les n millisecondes, n étant la valeur de l'intervalle.

Le multi-tache coopératif est sélectionné si la valeur de l'intervalle est nulle ; cela implique que le changement de contexte se fera lors d'une demande explicite (appel de la méthode yield(), fin de la méthode main(), attente de ressources, ...).

Le multi-tache profondément parallèle est sélectionné si la valeur de l'intervalle est égale à -1 ; cela implique que le changement de contexte se fera après chaque micro-instruction oRis.

Paramètres
interval - une valeur positive pour le multi-tache préemptif, nulle pour le multi-tache coopératif, et -1 pour le multi-tache profondément parallèle
Voir aussi
getInterval, yield

setMaxDepth

native void setMaxDepth(int maxDepth);

Indique le nombre de récursions ou de rebouclages maximum autorisé par oRis avant de générer une erreur de dépassement de pile interne.

Paramètres
maxDepth - le nombre maximum de boucles ou de récursions permises
Voir aussi
getMaxDepth

setPickingMode

native void setPickingMode(int mode);

Indique le mode de désignation des agents à prendre en compte.

La désignation aléatoire implique qu'à chaque cycle oRis, les méthodes main() des agents sont exécutées dans un ordre aléatoire, permettant de ne pas privilégier certains agents au détriment d'autres.

La désignation ordonnée au contraire implique qu'à chaque cycle oRis, les méthodes main() des agents sont exécutées toujours dans le meme ordre.

Paramètres
mode - la constante randomPicking (désignation aléatoire) ou serialPicking (désignation ordonnée)
Voir aussi
randomPicking, serialPicking, getPickingMode

showURL

native void showURL(string url, bool newWindow);

Lance le navigateur HTML par défaut de la machine, et affiche un document Internet.

Paramètres
url - l'adresse au format standard du document à afficher
newWindow - true pour afficher le document dans une nouvelle fenetre, false sinon (ne fonctionne que si le navigateur est déjà chargé)

signedSqrt

float signedSqrt(float x);

Calcule la racine carrée d'un réel, et préfixe le résultat du meme signe que le réel lui-meme.

Paramètres
x - un réel
Valeur de retour
la racine carrée signée de x

signedSquare

float signedSquare(float x);

Calcule le carré d'un réel, et préfixe le résultat du meme signe que le réel lui-meme.

Paramètres
x - un réel
Valeur de retour
le carré signé de x

sin

float sin(float x);

Calcule le sinus d'un réel.

Paramètres
x - un réel
Valeur de retour
le sinus de x

sinh

float sinh(float x);

Calcule le sinus hyperbolique d'un réel.

Paramètres
x - un réel
Valeur de retour
le sinus hyperbolique de x

sphereToCart

void sphereToCart(float & x, float & y, float & z, float d, float xyAngle, float zAngle);

Calcule les coordonnées cartésiennes du point défini par ses coordonnées sphériques.

Paramètres
x - l'abscisse cartésienne résultat
y - l'ordonnée cartésienne résultat
z - la cote cartésienne résultat
d - la distance sphérique du point
xyAngle - l'angle xy sphérique du point
zAngle - l'angle z sphérique du point

sqrt

float sqrt(float x);

Calcule la racine carrée d'un réel.

Paramètres
x - un réel
Valeur de retour
la racine carrée de x

square

float square(float x);

Calcule le carré d'un réel.

Paramètres
x - un réel
Valeur de retour
le carré de x

suspend

native void suspend(int execution);

Arrete temporairement le thread spécifié. Le thread peut etre réactivé à l'aide de la fonction resume() ; dans ce cas, il reprend son exécution à l'endroit meme ou il avait été stoppé par la fonction suspend().

Paramètres
execution - l'identificateur du thread à stopper
Voir aussi
resume

system

native int system(string command);

Exécute une commande système en aveugle, c'est à dire sans fournir de données supplémentaires particulières à cette commande, et sans lire les données présentes dans le flux de sortie ou d'erreur après l'exécution de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
Valeur de retour
le code de retour système de cette commande
Voir aussi
systemName

systemE

native string systemE(string command);

Exécute une commande système sans fournir de données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux d'erreur uniquement de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
Valeur de retour
les données présentes dans le flux d'erreur
Voir aussi
systemName

systemI

native void systemI(string command, string input);

Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, mais sans lire les données présentes dans le flux de sortie ou d'erreur de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
input - les données à fournir dans le flux d'entrée
Voir aussi
systemName

systemIE

native string systemIE(string command, string input);

Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux d'erreur uniquement de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
input - les données à fournir dans le flux d'entrée
Valeur de retour
les données présentes dans le flux d'erreur
Voir aussi
systemName

systemIO

native string systemIO(string command, string input);

Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux de sortie uniquement de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
input - les données à fournir dans le flux d'entrée
Valeur de retour
les données présentes dans le flux de sortie
Voir aussi
systemName

systemIOE

native string systemIOE(string command, string input, string & err);

Exécute une commande système en fournissant des données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans les flux de sortie et d'erreur de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
input - les données à fournir dans le flux d'entrée
err - les données présentes dans le flux d'erreur
Valeur de retour
les données présentes dans le flux de sortie
Voir aussi
systemName

systemName

native string systemName(bool detailed);

Obtient une chaine identifiant le système d'exploitation courant. Ceci est utile par exemple pour savoir quel caractère de séparation utiliser dans les noms de répertoire ("/" ou "\"), ou encore savoir si une instruction système exécutée par les fonctions systemXXX sera valide ou non.

Paramètres
detailed - true pour obtenir une chaine d'identification complète, ou false pour n'obtenir que le nom du système d'exploitation.
Valeur de retour
l'identification du système d'exploitation
Voir aussi
system

systemO

native string systemO(string command);

Exécute une commande système sans fournir de données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans le flux de sortie uniquement de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
Valeur de retour
les données présentes dans le flux de sortie
Voir aussi
systemName

systemOE

native string systemOE(string command, string & err);

Exécute une commande système sans fournir de données supplémentaires particulières dans le flux d'entrée de cette commande, et obtient les données présentes dans les flux de sortie et d'erreur de cette commande.

Paramètres
command - la commande à exécuter (qui doit etre compatible avec le système d'exploitation courant)
err - les données présentes dans le flux d'erreur
Valeur de retour
les données présentes dans le flux de sortie
Voir aussi
systemName

tan

float tan(float x);

Calcule la tangente d'un réel.

Paramètres
x - un réel
Valeur de retour
la tangente de x

tanh

float tanh(float x);

Calcule la tangente hyperbolique d'un réel.

Paramètres
x - un réel
Valeur de retour
la tangente hyperbolique de x

warning

void warning(type1 value1, type2 value2, ... ...);

Affiche la pile d'exécution du thread courant, puis un message d'avertissement spécifié, et poursuit l'exécution du thread courant.

Paramètres
value1 - le texte de l'avertissement à afficher (peut etre de n'importe quel type de données)
value2 - le texte de l'avertissement à afficher (peut etre de n'importe quel type de données)
... - ...

yield

native void yield();

Force le changement de contexte courant et active la tache suivante.

Voir aussi
setInterval


© Virtualys / E.N.I.B. / LI2 - Tous droits réservés
Dernières modifications :