doc/src/commands/generate.rst

   1 ****************
   2 Command generate
   3 ****************
   4
   5 Description
   6 ===========
   7 The **generate** command generates and compile SALOME modules from cpp modules using YACSGEN.
   8
   9 .. 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``.
  10
  11
  12 Remarks
  13 =======
  14 * This command will only apply on the CPP modules of the application, those who have both properties: ::
  15
  16         cpp : "yes"
  17         generate : "yes"
  18
  19 * The cpp module are usually computational components, and the generated module brings the CORBA layer which allows distributing the compononent on remore machines. cpp modules should conform to YACSGEN/hxx2salome requirements (please refer to YACSGEN documentation)
  20
  21
  22 Usage
  23 =====
  24 * Generate all the modules of a product: ::
  25
  26     sat generate <application>
  27
  28 * Generate only specific modules: ::
  29
  30     sat generate <application> --products <list of products>
  31
  32   Remark: modules which don't have the *generate* property are ignored.
  33
  34 * Use a specific version of YACSGEN: ::
  35
  36     sat generate <application> --yacsgen <path to yacsgen>
  37