doc/src/commands/generate.rst

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command generate
   5 ****************
   6
   7 Description
   8 ===========
   9 The **generate** command generates and compiles SALOME modules from cpp modules using YACSGEN.
  10
  11 .. note:: This command uses YACSGEN to generate the module. It needs to be specified with *--yacsgen* option, or defined in the product or by the environment variable ``$YACSGEN_ROOT_DIR``.
  12
  13
  14 Remarks
  15 =======
  16 * This command will only apply on the CPP modules of the application, those who have both properties: ::
  17
  18         cpp : "yes"
  19         generate : "yes"
  20
  21 * The cpp modules are usually computational components, and the generated module brings the CORBA layer which allows distributing the component on remote machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation).
  22
  23
  24 Usage
  25 =====
  26 * Generate all the modules of a product: ::
  27
  28     sat generate <application>
  29
  30 * Generate only specific modules: ::
  31
  32     sat generate <application> --products <list_of_products>
  33
  34   Remark: modules which don't have the *generate* property are ignored.
  35
  36 * Use a specific version of YACSGEN: ::
  37
  38     sat generate <application> --yacsgen <path_to_yacsgen>
  39