doc/salome/gui/KERNEL/kernel/using_catalog_generator.htm

   1 <!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">\r
   2 \r
   3 <html>\r
   4 \r
   5 <head>\r
   6 <title>Using Catalog Generator</title>\r
   7 <meta http-equiv="content-type" content="text/html; charset=windows-1252">\r
   8 <meta name="generator" content="RoboHelp by eHelp Corporation www.ehelp.com">\r
   9 <link rel="stylesheet" href="../default_ns.css"><script type="text/javascript" language="JavaScript" title="WebHelpSplitCss">\r
  10 <!--\r
  11 if (navigator.appName !="Netscape")\r
  12 {   document.write("<link rel='stylesheet' href='../default.css'>");}\r
  13 //-->\r
  14 </script>\r
  15 <style type="text/css">\r
  16 <!--\r
  17 h1.whs1 { font-family:'Times New Roman' , serif; }\r
  18 p.whs2 { margin-left:0px; text-align:justify; }\r
  19 img_whs3 { border:none; width:30px; height:30px; float:none; border-style:none; }\r
  20 p.whs4 { margin-left:0px; text-indent:48px; text-align:justify; }\r
  21 p.whs5 { text-align:justify; }\r
  22 p.whs6 { font-family:'Times New Roman' , serif; }\r
  23 p.whs7 { font-family:'Times New Roman' , serif; margin-left:40px; font-style:normal; color:#000000; }\r
  24 p.whs8 { font-family:'Times New Roman' , serif; margin-left:40px; }\r
  25 img_whs9 { border:none; width:475px; height:289px; float:none; border-style:none; }\r
  26 p.whs10 { font-family:'Times New Roman' , serif; margin-left:0px; }\r
  27 ul.whs11 { list-style:disc; }\r
  28 p.whs12 { font-family:'Times New Roman'  , serif; margin-left:0px; background-image:url('../texture_horiz_ltbluebubbles.jpg'); }\r
  29 img_whs13 { border:none; float:none; width:36px; height:38px; border-style:none; }\r
  30 img_whs14 { border:none; width:35px; height:37px; float:none; border-style:none; }\r
  31 p.whs15 { font-family:'Times New Roman' , serif; margin-left:0px; font-weight:bold; }\r
  32 -->\r
  33 </style><script type="text/javascript" language="JavaScript">\r
  34 <!--\r
  35 if ((navigator.appName == "Netscape") && (parseInt(navigator.appVersion) == 4))\r
  36 {\r
  37   var strNSS = "<style type='text/css'>";\r
  38   strNSS += "p.whs2 {margin-left:1pt; }";\r
  39   strNSS += "p.whs4 {margin-left:1pt; }";\r
  40   strNSS += "p.whs10 {margin-left:1pt; }";\r
  41   strNSS += "p.whs12 {margin-left:1pt; }";\r
  42   strNSS += "p.whs15 {margin-left:1pt; }";\r
  43   strNSS +="</style>";\r
  44   document.write(strNSS);\r
  45 }\r
  46 //-->\r
  47 </script>\r
  48 <script type="text/javascript" language="JavaScript" title="BSSC Special Effects" src="../ehlpdhtm.js"></script><script type="text/javascript" language="JavaScript" title="WebHelpInlineScript">\r
  49 <!--\r
  50 function reDo() {\r
  51   if (innerWidth != origWidth || innerHeight != origHeight)\r
  52      location.reload();\r
  53 }\r
  54 if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {\r
  55         origWidth = innerWidth;\r
  56         origHeight = innerHeight;\r
  57         onresize = reDo;\r
  58 }\r
  59 onerror = null; \r
  60 //-->\r
  61 </script>\r
  62 <style type="text/css">\r
  63 <!--\r
  64 div.WebHelpPopupMenu { position:absolute; left:0px; top:0px; z-index:4; visibility:hidden; }\r
  65 -->\r
  66 </style><script type="text/javascript" language="javascript1.2" src="../whmsg.js"></script>\r
  67 <script type="text/javascript" language="javascript" src="../whver.js"></script>\r
  68 <script type="text/javascript" language="javascript1.2" src="../whproxy.js"></script>\r
  69 <script type="text/javascript" language="javascript1.2" src="../whutils.js"></script>\r
  70 <script type="text/javascript" language="javascript1.2" src="../whtopic.js"></script>\r
  71 </head>\r
  72 <body><script type="text/javascript" language="javascript1.2">\r
  73 <!--\r
  74 if (window.gbWhTopic)\r
  75 {\r
  76         if (window.addTocInfo)\r
  77         {\r
  78         addTocInfo("GUI module\nUsing Catalog Generator");\r
  79 addButton("show",BTN_TEXT,"Show","","","","",0,0,"","","");\r
  80 \r
  81         }\r
  82         if (window.writeBtnStyle)\r
  83                 writeBtnStyle();\r
  84 \r
  85         if (window.writeIntopicBar)\r
  86                 writeIntopicBar(1);\r
  87 \r
  88         if (window.setRelStartPage)\r
  89         {\r
  90         setRelStartPage("../kernel.htm");\r
  91 \r
  92                 autoSync(1);\r
  93                 sendSyncInfo();\r
  94                 sendAveInfoOut();\r
  95         }\r
  96 }\r
  97 else\r
  98         if (window.gbIE4)\r
  99                 document.location.reload();\r
 100 //-->\r
 101 </script>\r
 102 <h1 class="whs1">Using Catalog Generator \r
 103  (for advanced users)</h1>\r
 104 \r
 105 <p class="whs2"><img src="../i_blue.jpg" x-maintain-ratio="TRUE" width="30px" height="30px" border="0" class="img_whs3"> &nbsp;&nbsp;&nbsp;SALOME \r
 106  platform is an open platform for integration of your custom components, \r
 107  which can used in the same way as typical modules provided in the standard \r
 108  installed package. The <span style="font-weight: bold;"><B>Catalog Generator \r
 109  </B></span>tool serves for implementation of the interface of your custom \r
 110  component. It allows to generate from IDL description of your component \r
 111  interface its xml description. &nbsp;The \r
 112  component xml description allows SALOME application to know about the \r
 113  component and its services and provides the possibility to call the component \r
 114  services, for example, inside Supervisor module.</p>\r
 115 \r
 116 <p class="whs4">If you have a look at runSalome, runSalomeWithPort \r
 117  scripts running SALOME application, which are stored in build/bin directory \r
 118  you will see that SALOME_ModuleCatalog_Server is started with two xml \r
 119  files as its input parameters: <span style="font-weight: bold;"><B>CatalogModuleGeneral.xml</B></span> \r
 120  and <span style="font-weight: bold;"><B>CatalogModulePersonnel.xml</B></span>. \r
 121  These two files store the descriptions of interfaces and services of all \r
 122  components, provided with typical SALOME package. To add a new component \r
 123  into SALOME platform you should either update one of these existing xml \r
 124  files with generated xml description of your component or create a new \r
 125  one.</p>\r
 126 \r
 127 <p class="whs5">&nbsp;</p>\r
 128 \r
 129 <p class=TODO>To open the Catalog Generator:</p>\r
 130 \r
 131 <p class="whs6">&nbsp;</p>\r
 132 \r
 133 <p class="whs7">From the main menu choose <span style="font-weight: bold;"><B>Tools \r
 134  &gt; Catalog Generato</B></span>r, the following dialog box will appear:</p>\r
 135 \r
 136 <p>&nbsp;</p>\r
 137 \r
 138 <p class="whs8"><img src="../pics/cataloggenerator.png" x-maintain-ratio="TRUE" width="475px" height="289px" border="0" class="img_whs9"></p>\r
 139 \r
 140 <p class="whs8">&nbsp;</p>\r
 141 \r
 142 <p class="whs10">&nbsp;</p>\r
 143 \r
 144 <p class="whs10">In \r
 145  this dialog box you can specify:</p>\r
 146 \r
 147 <p class="whs10">&nbsp;</p>\r
 148 \r
 149 <ul type="disc" class="whs11">\r
 150         \r
 151         <li class=kadov-p><p class="whs8">Name \r
 152  and location of the IDL file describing the interface of your component \r
 153  (Click the <span style="font-weight: bold;"><B>Browse</B></span> button to find \r
 154  it using the data tree).</p></li>\r
 155         \r
 156         <li class=kadov-p><p class="whs8">Name \r
 157  and location of an existing XML file, which will be updated with the interface \r
 158  of you component or name and desired location of a new XML file, which \r
 159  will be generated (Click the <span style="font-weight: bold;"><B>Browse</B></span> \r
 160  button to find it using the data tree).</p></li>\r
 161         \r
 162         <li class=kadov-p><p class="whs8">Name \r
 163  of the author,</p></li>\r
 164         \r
 165         <li class=kadov-p><p class="whs8">Name \r
 166  of the component,</p></li>\r
 167         \r
 168         <li class=kadov-p><p class="whs8">Name \r
 169  of the user</p></li>\r
 170         \r
 171         <li class=kadov-p><p class="whs8">Version,</p></li>\r
 172         \r
 173         <li class=kadov-p><p class="whs8">Capability \r
 174  of multi study support</p></li>\r
 175         \r
 176         <li class=kadov-p><p class="whs8">Type \r
 177  of the component,</p></li>\r
 178         \r
 179         <li class=kadov-p><p class="whs8">Icon \r
 180  of your component (Click the <span style="font-weight: bold;"><B>Browse</B></span> \r
 181  button to find it using the data tree).</p></li>\r
 182 </ul>\r
 183 \r
 184 <p class="whs8">&nbsp;</p>\r
 185 \r
 186 <p class="whs12"><img src="../note1.gif" x-maintain-ratio="TRUE" width="36px" height="38px" border="0" class="img_whs13">If you have chosen to create a new xml file containing the \r
 187  description of your component, don't forget to specify it as input parameter \r
 188  for SALOME_ModuleCatalog_Server in the file, you are using as a running \r
 189  script of SALOME platform (in runSalomeWithPort, for example).</p>\r
 190 \r
 191 <p class="whs10">&nbsp;</p>\r
 192 \r
 193 <p class="whs10">&nbsp;When \r
 194  launching SALOME next time you will see your module alongside other components.</p>\r
 195 \r
 196 <p class="whs10">&nbsp;</p>\r
 197 \r
 198 <p class="whs12"><img src="../tip1.gif" x-maintain-ratio="TRUE" width="35px" height="37px" border="0" class="img_whs14"> You can use the <span style="font-weight: bold;"><B>Catalog \r
 199  Generator</B></span> tool, if you would like to <span style="font-weight: bold;"><B>test</B></span> \r
 200  the functionality of your new component. After implementation of your \r
 201  component interface, launch SUPERVISION module where you can try using \r
 202  the services of your new component. (see also: Adding factory nodes)</p>\r
 203 \r
 204 <p class="whs10">&nbsp;</p>\r
 205 \r
 206 <p class="whs10">&nbsp;</p>\r
 207 \r
 208 <p class="whs15">\r
 209 <a href="javascript:void(0);" onClick="var e; if (parseInt(navigator.appVersion)>=4){e=event;}  if (parseInt(navigator.appVersion) >=2 && typeof(PickupDialog_Invoke) == 'function') PickupDialog_Invoke(e,'','Introduction to GUI','../introduction_to_gui.htm','SALOME desktop','salome_pro_desktop.htm');return false;" title="Related Topics"><img src="../ss_btn_related_topics.gif" border=0 height=17 width=82 alt="Related Topics"></a>\r
 210 \r
 211 \r
 212  </p>\r
 213 \r
 214 <p class="whs15">&nbsp;</p>\r
 215 \r
 216 <p class="whs15">&nbsp;</p>\r
 217 \r
 218 <script type="text/javascript" language="JavaScript" title="WebHelpRelatedTopics"><!--\r
 219 if (parseInt(navigator.appVersion) >= 3 && typeof (WritePopupMenuLayer) == "function")\r
 220   WritePopupMenuLayer();\r
 221 //--></script><script type="text/javascript" language="javascript1.2">\r
 222 <!--\r
 223 if (window.writeIntopicBar)\r
 224         writeIntopicBar(0);\r
 225 //-->\r
 226 </script>\r
 227 </body>\r
 228 </html>\r