doc/salome/gui/input/using_catalog_generator.rst

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