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

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