doc/salome/gui/input/using_catalog_generator.doc

   1 /*!
   2
   3 \page using_catalog_generator_page Using Catalog Generator
   4
   5 SALOME platform is an open platform for
   6 integration of your custom components, which can used in the same way
   7 as typical modules provided in the standard installed package. The
   8 <b>Catalog Generator</b> tool serves for implementation of the interface of
   9 your custom component. It allows to generate from IDL description of
  10 your component interface its xml description.  The component xml
  11 description allows SALOME application to know about the component and
  12 its services and provides the possibility to call the component
  13 services, for example, inside Supervisor module.
  14
  15 If you have a look at runSalome,
  16 runSalomeWithPort scripts running SALOME application, which are stored
  17 in build/bin directory you will see that SALOME_ModuleCatalog_Server
  18 is started with two xml files as its input parameters:
  19 \b CatalogModuleGeneral.xml and \b CatalogModulePersonnel.xml. These two
  20 files store the descriptions of interfaces and services of all
  21 components, provided with typical SALOME package. To add a new
  22 component into SALOME platform you should either update one of these
  23 existing xml files with generated xml description of your component or
  24 create a new one.
  25
  26 <em>To open the Catalog Generator:</em>
  27 \par
  28 From the main menu choose <b>Tools > Catalog Generator</b>, the following
  29 dialog box will appear:
  30
  31 \image html cataloggenerator.png
  32
  33 <br>In this dialog box you can specify:
  34 <ul>
  35 <li>Name and location of the IDL file describing the interface of your
  36 component (Click the \b Browse button to find it using the data tree).</li>
  37 <li>Name and location of an existing XML file, which will be updated
  38 with the interface of you component or name and desired location of a
  39 new XML file, which will be generated (Click the \b Browse button to find
  40 it using the data tree).</li>
  41 <li>Name of the author.</li>
  42 <li>Name of the component.</li>
  43 <li>Name of the user.</li>
  44 <li>Version.</li>
  45 <li>Capability of multi study support.</li>
  46 <li>Type of the component.</li>
  47 <li>Icon of your component (Click the \b Browse button to find it using
  48 the data tree).</li>
  49 </ul>
  50
  51 \note If you have chosen to create a new xml file containing the
  52 description of your component, don't forget to specify it as
  53 input parameter for SALOME_ModuleCatalog_Server in the file, you are
  54 using as a running script of SALOME platform (in runSalomeWithPort,
  55 for example).
  56
  57 When launching SALOME next time you will see your module alongside other components.
  58
  59 \b Tip: You can use the <b>Catalog Generator</b> tool, if you would like to \b
  60 test the functionality of your new component. After implementation of
  61 your component interface, launch SUPERVISION module where you can try
  62 using the services of your new component. (see also: Adding factory
  63 nodes)
  64
  65 */