Difference between revisions of "ONELAB scripting syntax"

Revision as of 12:12, 17 September 2012

Clients declaration

name.register(interfaced|encapsulated, pathname);

register the client name as an interfaced or native (encapsulated) client. The second argument is the commandline (full pathname or any alias that would be defined on your system)

name.Path(path)

defines the pathname of the client executable, if it was not given in the register statement.

name.in(file,...)

comma-separated list of input files. Their presence is checked before execution. File with a .ol extension are also converted before execution.

name'.out(file,...)

comma separated list of output files. They are deleted before execution.

name.PreLineOptions(options)

définit des options en ligne de commande à placer avant la liste des fichiers d'entrée (facultatif)

name.LineOptions('options)

définit des options en ligne de commande à placer après la liste des fichiers d'entrée (facultatif)

name.Active(0|1)

définit si le client est appelé ou non lors de l'exécution (valeur par défaut:1)

Parameter declaration

OL.parameter param_def; <param_def; ...>

où param_def est une des commandes suivantes:

name.number(Value,Path,Range,ShortHelp)

définit un paramètre numérique Path/name, lui attribue la valeur Value et le range Range.

La donnée Range est soit a:b:c (p.ex. 1:10:1) où a est la valeur minimale, b la valeur maximale et c le step; soit a:b#n où n est le nombre de steps.

name.string(Value,Path,ShortHelp)

définit un paramètre de type string

Conditional statements

OL.iftrue(param)

lignes de codes transférées si le paramètre "param est différent de 0 ou ""

OL.else

lignes de codes transférées si le paramètre "param est égal à 0 ""

OL.endif

File inclusion

OL.include(file)

insert here the result of the preprocessing of the file file

Value substitution

OL.get(name)

insert here the value from the server of the parameter name. This command may appear several time in the same line.