doc/build/html/commands/generate.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>Command generate &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="../genindex.html" />
  18     <link rel="search" title="Search" href="../search.html" />
  19     <link rel="next" title="Add a user custom command" href="../write_command.html" />
  20     <link rel="prev" title="Command package" href="package.html" />
  21
  22   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  23
  24
  25   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  26
  27   </head><body>
  28
  29
  30     <div class="document">
  31       <div class="documentwrapper">
  32         <div class="bodywrapper">
  33           <div class="body" role="main">
  34
  35   <div class="section" id="command-generate">
  36 <h1>Command generate<a class="headerlink" href="#command-generate" title="Permalink to this headline">¶</a></h1>
  37 <div class="section" id="description">
  38 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  39 <p>The <strong>generate</strong> command generates and compile SALOME modules from cpp modules using YACSGEN.</p>
  40 <div class="admonition note">
  41 <p class="first admonition-title">Note</p>
  42 <p class="last">This command uses YACSGEN to generate the module. It needs to be specified with <em>–yacsgen</em> option, or defined in the product or by the environment variable <code class="docutils literal notranslate"><span class="pre">$YACSGEN_ROOT_DIR</span></code>.</p>
  43 </div>
  44 </div>
  45 <div class="section" id="remarks">
  46 <h2>Remarks<a class="headerlink" href="#remarks" title="Permalink to this headline">¶</a></h2>
  47 <ul>
  48 <li><p class="first">This command will only apply on the CPP modules of the application, those who have both properties:</p>
  49 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cpp</span> <span class="p">:</span> <span class="s2">&quot;yes&quot;</span>
  50 <span class="n">generate</span> <span class="p">:</span> <span class="s2">&quot;yes&quot;</span>
  51 </pre></div>
  52 </div>
  53 </li>
  54 <li><p class="first">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)</p>
  55 </li>
  56 </ul>
  57 </div>
  58 <div class="section" id="usage">
  59 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  60 <ul>
  61 <li><p class="first">Generate all the modules of a product:</p>
  62 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span>
  63 </pre></div>
  64 </div>
  65 </li>
  66 <li><p class="first">Generate only specific modules:</p>
  67 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">products</span> <span class="o">&lt;</span><span class="n">list_of_products</span><span class="o">&gt;</span>
  68 </pre></div>
  69 </div>
  70 <p>Remark: modules which don’t have the <em>generate</em> property are ignored.</p>
  71 </li>
  72 <li><p class="first">Use a specific version of YACSGEN:</p>
  73 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">generate</span> <span class="o">&lt;</span><span class="n">application</span><span class="o">&gt;</span> <span class="o">--</span><span class="n">yacsgen</span> <span class="o">&lt;</span><span class="n">path_to_yacsgen</span><span class="o">&gt;</span>
  74 </pre></div>
  75 </div>
  76 </li>
  77 </ul>
  78 </div>
  79 </div>
  80
  81
  82           </div>
  83         </div>
  84       </div>
  85       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  86         <div class="sphinxsidebarwrapper">
  87             <p class="logo"><a href="../index.html">
  88               <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
  89             </a></p>
  90   <h3><a href="../index.html">Table Of Contents</a></h3>
  91   <ul>
  92 <li><a class="reference internal" href="#">Command generate</a><ul>
  93 <li><a class="reference internal" href="#description">Description</a></li>
  94 <li><a class="reference internal" href="#remarks">Remarks</a></li>
  95 <li><a class="reference internal" href="#usage">Usage</a></li>
  96 </ul>
  97 </li>
  98 </ul>
  99 <div class="relations">
 100 <h3>Related Topics</h3>
 101 <ul>
 102   <li><a href="../index.html">Documentation overview</a><ul>
 103       <li>Previous: <a href="package.html" title="previous chapter">Command package</a></li>
 104       <li>Next: <a href="../write_command.html" title="next chapter">Add a user custom command</a></li>
 105   </ul></li>
 106 </ul>
 107 </div>
 108   <div role="note" aria-label="source link">
 109     <h3>This Page</h3>
 110     <ul class="this-page-menu">
 111       <li><a href="../_sources/commands/generate.rst.txt"
 112             rel="nofollow">Show Source</a></li>
 113     </ul>
 114    </div>
 115 <div id="searchbox" style="display: none" role="search">
 116   <h3>Quick search</h3>
 117     <div class="searchformwrapper">
 118     <form class="search" action="../search.html" method="get">
 119       <input type="text" name="q" />
 120       <input type="submit" value="Go" />
 121       <input type="hidden" name="check_keywords" value="yes" />
 122       <input type="hidden" name="area" value="default" />
 123     </form>
 124     </div>
 125 </div>
 126 <script type="text/javascript">$('#searchbox').show(0);</script>
 127         </div>
 128       </div>
 129       <div class="clearer"></div>
 130     </div>
 131     <div class="footer">
 132       &copy;2018, CEA.
 133
 134       |
 135       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 136       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 137
 138       |
 139       <a href="../_sources/commands/generate.rst.txt"
 140           rel="nofollow">Page source</a>
 141     </div>
 142
 143
 144
 145
 146   </body>
 147 </html>