Salome HOME
Documentation update related to adding init_port option to driver command.
authorOvidiu Mircescu <ovidiu.mircescu@edf.fr>
Mon, 14 Mar 2016 14:58:36 +0000 (15:58 +0100)
committerOvidiu Mircescu <ovidiu.mircescu@edf.fr>
Thu, 17 Mar 2016 14:55:50 +0000 (15:55 +0100)
doc/execxml.rst

index cddd6e2ba32355b3091320154328365bf6a8438b..fc0a0855c4d3b70e974d0b38e13e58fcf0467636 100644 (file)
@@ -30,6 +30,8 @@ The YACS supervisor in console (driver) mode accepts a few options to set parame
     -e, --dump-on-error[=file] Stop on first error and dump state
     -f, --dump-final[=file]    dump final state
     -g, --dump[=nbsec]         dump state
+    -i, --init_port[=value]    Initialisation value of a port, specified as
+                               bloc.node.port=value.
     -k, --kill-port=port       Kill Salome application running on the specified
                                port if the driver process is killed (with SIGINT
                                or SIGTERM)
@@ -97,6 +99,20 @@ Execute a scheme and save the state of execution every 30 seconds
 
   driver -g30 -fmystate.xml schema.xml
 
+Change the values of some input ports before execution
+----------------------------------------------------------------------
+::
+
+  driver -imynode.i=5 -imynode.d=.7 -imynode.b=False -imynode.s=lili schema.xml
+
+In this example, the ports "i", "d", "b" and "s" of the node "mynode" are initialized and the schema is launched.
+
+Only the ports of the following types can be initialized this way:
+
+ - int
+ - double
+ - bool
+ - string
 
 How to manage several SALOME sessions
 ----------------------------------------------------------------------