Difference between revisions of "ONELAB scripting syntax"

Revision as of 12:31, 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 executable name (full pathname or any alias that would be defined on your system).

name.commandLine(path)

defines the pathname to the client executable, if it was not given as second argument 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 converted before execution.

name.out(file,...)

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

name.args('options)

the stringoptions is interpreted (if it contains substitution statements) and appended to the commandline when calling the client.

name.Active(0|1)

sets the client active or inactive. Inactive clients are not executed but remain registered.

name.up(file,j,k,Parameter/Name, ...)

tells ONELAB to extract the kth numbers from the jst line in the file file, and to upload it as a new parameters named Parameter/Name. If the line number j is "-1", the last line of the file is considered instead of the jth. The group of four arguments can be repeated in one single "up" statement to upload several parameters.

name.merge(file, ...)

comma separated list of solution files interpretable by Gmsh (.pos, .msh, .geo, ...) to be merged after execution.

name.check()

This optional statement forces the client to be checked immediately after its declaration so that parameters defined in the .geo file can be used directly in the sequel of the metamodel definition.

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.