doc/salome/gui/VISU/visugenidl_doc/interfaceVISU_1_1Result.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
   2 <html>
   3 <head>
   4    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   5    <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
   6    <title>Main Page</title>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css">
   8 </head>
   9 <body>
  10 &nbsp;
  11 </body>
  12 </html>
  13 <!-- Generated by Doxygen 1.4.6 -->
  14 <h1>VISU.Result Interface Reference</h1><!-- doxytag: class="VISU::Result" --><!-- doxytag: inherits="VISU::RemovableObject,SALOME::GenericObj" -->Interface Result.
  15 <a href="#_details">More...</a>
  16 <p>
  17 <code>import &quot;<a class="el" href="VISU__Gen_8idl-source.html">VISU_Gen.idl</a>&quot;;</code>
  18 <p>
  19 Inheritance diagram for VISU.Result:<p><center><img src="interfaceVISU_1_1Result__inherit__graph.jpg" border="0" alt="Inheritance graph"></center>
  20 <table border="0" cellpadding="0" cellspacing="0">
  21 <tr><td></td></tr>
  22 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  23 <tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#a6260841efa4694504f6e21590a4c50a">BuildAll</a> ()</td></tr>
  24
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#7a46d5659c95adae95b4329916af1fec">Build</a> (in boolean theIsBuildAll, in boolean theIsAtOnce)</td></tr>
  26
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#d1ef69caf6a76c8ed0a8297f436ffbd4">IsDone</a> ()</td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#b412602578606b93a81b8c6359996190">IsEntitiesDone</a> ()</td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#5e1c8ee717350540d98cd3db0e5cc2a3">SetBuildFields</a> (in boolean theIsBuildFields, in boolean theIsCalculateMinMax)</td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#59a809f9bc88f96c8df98a0e95dbbbdf">IsFieldsDone</a> ()</td></tr>
  34
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#468d7606f2efde5d765fb33242f34373">SetBuildGroups</a> (in boolean theIsBuildGroups)</td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#02fa556cedd2bb0d86089e6811ab6609">IsGroupsDone</a> ()</td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Result.html#ce7b1e63efe426c4fb8c357524eae854">IsMinMaxDone</a> ()</td></tr>
  40
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1RemovableObject.html#7d053f4324b26edd325024cd45424f13">RemoveFromStudy</a> ()</td></tr>
  42
  43 <tr><td class="memItemLeft" nowrap align="right" valign="top">IdType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#5da28cc23f3657dd24a3b8598319c522">GetID</a> ()</td></tr>
  44
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">VISUType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#6f62d77b0451737114b5a10bf23be21e">GetType</a> ()</td></tr>
  46
  47 </table>
  48 <hr><a name="_details"></a><h2>Detailed Description</h2>
  49 This interface serves for inner representation of data generated in other sources (<a class="el" href="namespaceMED.html">MED</a> object or file). This data is needed for further construction of graphical presentations.
  50 <p>
  51 <hr><h2>Member Function Documentation</h2>
  52 <a class="anchor" name="a6260841efa4694504f6e21590a4c50a"></a><!-- doxytag: member="VISU::Result::BuildAll" ref="a6260841efa4694504f6e21590a4c50a" args="()" --><p>
  53 <table class="mdTable" cellpadding="2" cellspacing="0">
  54   <tr>
  55     <td class="mdRow">
  56       <table cellpadding="0" cellspacing="0" border="0">
  57         <tr>
  58           <td class="md" nowrap valign="top">boolean VISU.Result.BuildAll           </td>
  59           <td class="md" valign="top">(&nbsp;</td>
  60           <td class="mdname1" valign="top" nowrap>          </td>
  61           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  62           <td class="md" nowrap></td>
  63         </tr>
  64       </table>
  65     </td>
  66   </tr>
  67 </table>
  68 <table cellspacing="5" cellpadding="0" border="0">
  69   <tr>
  70     <td>
  71       &nbsp;
  72     </td>
  73     <td>
  74
  75 <p>
  76 Reads all data from the corresponding sources. By default the data is loaded on demand.     </td>
  77   </tr>
  78 </table>
  79 <a class="anchor" name="7a46d5659c95adae95b4329916af1fec"></a><!-- doxytag: member="VISU::Result::Build" ref="7a46d5659c95adae95b4329916af1fec" args="(in boolean theIsBuildAll, in boolean theIsAtOnce)" --><p>
  80 <table class="mdTable" cellpadding="2" cellspacing="0">
  81   <tr>
  82     <td class="mdRow">
  83       <table cellpadding="0" cellspacing="0" border="0">
  84         <tr>
  85           <td class="md" nowrap valign="top">boolean VISU.Result.Build           </td>
  86           <td class="md" valign="top">(&nbsp;</td>
  87           <td class="md" nowrap valign="top">in boolean&nbsp;</td>
  88           <td class="mdname" nowrap> <em>theIsBuildAll</em>, </td>
  89         </tr>
  90         <tr>
  91           <td class="md" nowrap align="right"></td>
  92           <td class="md"></td>
  93           <td class="md" nowrap>in boolean&nbsp;</td>
  94           <td class="mdname" nowrap> <em>theIsAtOnce</em></td>
  95         </tr>
  96         <tr>
  97           <td class="md"></td>
  98           <td class="md">)&nbsp;</td>
  99           <td class="md" colspan="2"></td>
 100         </tr>
 101       </table>
 102     </td>
 103   </tr>
 104 </table>
 105 <table cellspacing="5" cellpadding="0" border="0">
 106   <tr>
 107     <td>
 108       &nbsp;
 109     </td>
 110     <td>
 111
 112 <p>
 113 Start to parse the source <a class="el" href="namespaceMED.html">MED</a> file and publish all its entities into the study     </td>
 114   </tr>
 115 </table>
 116 <a class="anchor" name="d1ef69caf6a76c8ed0a8297f436ffbd4"></a><!-- doxytag: member="VISU::Result::IsDone" ref="d1ef69caf6a76c8ed0a8297f436ffbd4" args="()" --><p>
 117 <table class="mdTable" cellpadding="2" cellspacing="0">
 118   <tr>
 119     <td class="mdRow">
 120       <table cellpadding="0" cellspacing="0" border="0">
 121         <tr>
 122           <td class="md" nowrap valign="top">boolean VISU.Result.IsDone           </td>
 123           <td class="md" valign="top">(&nbsp;</td>
 124           <td class="mdname1" valign="top" nowrap>          </td>
 125           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 126           <td class="md" nowrap></td>
 127         </tr>
 128       </table>
 129     </td>
 130   </tr>
 131 </table>
 132 <table cellspacing="5" cellpadding="0" border="0">
 133   <tr>
 134     <td>
 135       &nbsp;
 136     </td>
 137     <td>
 138
 139 <p>
 140 Allow to check is all requested <a class="el" href="namespaceMED.html">MED</a> entites already loaded or not     </td>
 141   </tr>
 142 </table>
 143 <a class="anchor" name="b412602578606b93a81b8c6359996190"></a><!-- doxytag: member="VISU::Result::IsEntitiesDone" ref="b412602578606b93a81b8c6359996190" args="()" --><p>
 144 <table class="mdTable" cellpadding="2" cellspacing="0">
 145   <tr>
 146     <td class="mdRow">
 147       <table cellpadding="0" cellspacing="0" border="0">
 148         <tr>
 149           <td class="md" nowrap valign="top">boolean VISU.Result.IsEntitiesDone           </td>
 150           <td class="md" valign="top">(&nbsp;</td>
 151           <td class="mdname1" valign="top" nowrap>          </td>
 152           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 153           <td class="md" nowrap></td>
 154         </tr>
 155       </table>
 156     </td>
 157   </tr>
 158 </table>
 159 <table cellspacing="5" cellpadding="0" border="0">
 160   <tr>
 161     <td>
 162       &nbsp;
 163     </td>
 164     <td>
 165
 166 <p>
 167 Allow to check is corresponding <a class="el" href="namespaceMED.html">MED</a> entites already loaded or not     </td>
 168   </tr>
 169 </table>
 170 <a class="anchor" name="5e1c8ee717350540d98cd3db0e5cc2a3"></a><!-- doxytag: member="VISU::Result::SetBuildFields" ref="5e1c8ee717350540d98cd3db0e5cc2a3" args="(in boolean theIsBuildFields, in boolean theIsCalculateMinMax)" --><p>
 171 <table class="mdTable" cellpadding="2" cellspacing="0">
 172   <tr>
 173     <td class="mdRow">
 174       <table cellpadding="0" cellspacing="0" border="0">
 175         <tr>
 176           <td class="md" nowrap valign="top">void VISU.Result.SetBuildFields           </td>
 177           <td class="md" valign="top">(&nbsp;</td>
 178           <td class="md" nowrap valign="top">in boolean&nbsp;</td>
 179           <td class="mdname" nowrap> <em>theIsBuildFields</em>, </td>
 180         </tr>
 181         <tr>
 182           <td class="md" nowrap align="right"></td>
 183           <td class="md"></td>
 184           <td class="md" nowrap>in boolean&nbsp;</td>
 185           <td class="mdname" nowrap> <em>theIsCalculateMinMax</em></td>
 186         </tr>
 187         <tr>
 188           <td class="md"></td>
 189           <td class="md">)&nbsp;</td>
 190           <td class="md" colspan="2"></td>
 191         </tr>
 192       </table>
 193     </td>
 194   </tr>
 195 </table>
 196 <table cellspacing="5" cellpadding="0" border="0">
 197   <tr>
 198     <td>
 199       &nbsp;
 200     </td>
 201     <td>
 202
 203 <p>
 204 Choose to parse <a class="el" href="namespaceMED.html">MED</a> fields and perform global min / max on the <a class="el" href="namespaceMED.html">MED</a> timestamps.     </td>
 205   </tr>
 206 </table>
 207 <a class="anchor" name="59a809f9bc88f96c8df98a0e95dbbbdf"></a><!-- doxytag: member="VISU::Result::IsFieldsDone" ref="59a809f9bc88f96c8df98a0e95dbbbdf" args="()" --><p>
 208 <table class="mdTable" cellpadding="2" cellspacing="0">
 209   <tr>
 210     <td class="mdRow">
 211       <table cellpadding="0" cellspacing="0" border="0">
 212         <tr>
 213           <td class="md" nowrap valign="top">boolean VISU.Result.IsFieldsDone           </td>
 214           <td class="md" valign="top">(&nbsp;</td>
 215           <td class="mdname1" valign="top" nowrap>          </td>
 216           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 217           <td class="md" nowrap></td>
 218         </tr>
 219       </table>
 220     </td>
 221   </tr>
 222 </table>
 223 <table cellspacing="5" cellpadding="0" border="0">
 224   <tr>
 225     <td>
 226       &nbsp;
 227     </td>
 228     <td>
 229
 230 <p>
 231 Allow to check is corresponding <a class="el" href="namespaceMED.html">MED</a> fields already loaded or not     </td>
 232   </tr>
 233 </table>
 234 <a class="anchor" name="468d7606f2efde5d765fb33242f34373"></a><!-- doxytag: member="VISU::Result::SetBuildGroups" ref="468d7606f2efde5d765fb33242f34373" args="(in boolean theIsBuildGroups)" --><p>
 235 <table class="mdTable" cellpadding="2" cellspacing="0">
 236   <tr>
 237     <td class="mdRow">
 238       <table cellpadding="0" cellspacing="0" border="0">
 239         <tr>
 240           <td class="md" nowrap valign="top">void VISU.Result.SetBuildGroups           </td>
 241           <td class="md" valign="top">(&nbsp;</td>
 242           <td class="md" nowrap valign="top">in boolean&nbsp;</td>
 243           <td class="mdname1" valign="top" nowrap> <em>theIsBuildGroups</em>          </td>
 244           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 245           <td class="md" nowrap></td>
 246         </tr>
 247       </table>
 248     </td>
 249   </tr>
 250 </table>
 251 <table cellspacing="5" cellpadding="0" border="0">
 252   <tr>
 253     <td>
 254       &nbsp;
 255     </td>
 256     <td>
 257
 258 <p>
 259 Choose to parse <a class="el" href="namespaceMED.html">MED</a> groups.     </td>
 260   </tr>
 261 </table>
 262 <a class="anchor" name="02fa556cedd2bb0d86089e6811ab6609"></a><!-- doxytag: member="VISU::Result::IsGroupsDone" ref="02fa556cedd2bb0d86089e6811ab6609" args="()" --><p>
 263 <table class="mdTable" cellpadding="2" cellspacing="0">
 264   <tr>
 265     <td class="mdRow">
 266       <table cellpadding="0" cellspacing="0" border="0">
 267         <tr>
 268           <td class="md" nowrap valign="top">boolean VISU.Result.IsGroupsDone           </td>
 269           <td class="md" valign="top">(&nbsp;</td>
 270           <td class="mdname1" valign="top" nowrap>          </td>
 271           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 272           <td class="md" nowrap></td>
 273         </tr>
 274       </table>
 275     </td>
 276   </tr>
 277 </table>
 278 <table cellspacing="5" cellpadding="0" border="0">
 279   <tr>
 280     <td>
 281       &nbsp;
 282     </td>
 283     <td>
 284
 285 <p>
 286 Allow to check is corresponding <a class="el" href="namespaceMED.html">MED</a> groups and families already loaded or not     </td>
 287   </tr>
 288 </table>
 289 <a class="anchor" name="ce7b1e63efe426c4fb8c357524eae854"></a><!-- doxytag: member="VISU::Result::IsMinMaxDone" ref="ce7b1e63efe426c4fb8c357524eae854" args="()" --><p>
 290 <table class="mdTable" cellpadding="2" cellspacing="0">
 291   <tr>
 292     <td class="mdRow">
 293       <table cellpadding="0" cellspacing="0" border="0">
 294         <tr>
 295           <td class="md" nowrap valign="top">boolean VISU.Result.IsMinMaxDone           </td>
 296           <td class="md" valign="top">(&nbsp;</td>
 297           <td class="mdname1" valign="top" nowrap>          </td>
 298           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 299           <td class="md" nowrap></td>
 300         </tr>
 301       </table>
 302     </td>
 303   </tr>
 304 </table>
 305 <table cellspacing="5" cellpadding="0" border="0">
 306   <tr>
 307     <td>
 308       &nbsp;
 309     </td>
 310     <td>
 311
 312 <p>
 313 Allow to check is min / max calculation over field's components already perfrormed or not     </td>
 314   </tr>
 315 </table>
 316 <a class="anchor" name="7d053f4324b26edd325024cd45424f13"></a><!-- doxytag: member="VISU::Result::RemoveFromStudy" ref="7d053f4324b26edd325024cd45424f13" args="()" --><p>
 317 <table class="mdTable" cellpadding="2" cellspacing="0">
 318   <tr>
 319     <td class="mdRow">
 320       <table cellpadding="0" cellspacing="0" border="0">
 321         <tr>
 322           <td class="md" nowrap valign="top">void VISU.RemovableObject.RemoveFromStudy           </td>
 323           <td class="md" valign="top">(&nbsp;</td>
 324           <td class="mdname1" valign="top" nowrap>          </td>
 325           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 326           <td class="md" nowrap><code> [inherited]</code></td>
 327         </tr>
 328       </table>
 329     </td>
 330   </tr>
 331 </table>
 332 <table cellspacing="5" cellpadding="0" border="0">
 333   <tr>
 334     <td>
 335       &nbsp;
 336     </td>
 337     <td>
 338
 339 <p>
 340 Remove object from study.     </td>
 341   </tr>
 342 </table>
 343 <a class="anchor" name="5da28cc23f3657dd24a3b8598319c522"></a><!-- doxytag: member="VISU::Result::GetID" ref="5da28cc23f3657dd24a3b8598319c522" args="()" --><p>
 344 <table class="mdTable" cellpadding="2" cellspacing="0">
 345   <tr>
 346     <td class="mdRow">
 347       <table cellpadding="0" cellspacing="0" border="0">
 348         <tr>
 349           <td class="md" nowrap valign="top">IdType VISU.Base.GetID           </td>
 350           <td class="md" valign="top">(&nbsp;</td>
 351           <td class="mdname1" valign="top" nowrap>          </td>
 352           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 353           <td class="md" nowrap><code> [inherited]</code></td>
 354         </tr>
 355       </table>
 356     </td>
 357   </tr>
 358 </table>
 359 <table cellspacing="5" cellpadding="0" border="0">
 360   <tr>
 361     <td>
 362       &nbsp;
 363     </td>
 364     <td>
 365
 366 <p>
 367 Returns ID of the object.     </td>
 368   </tr>
 369 </table>
 370 <a class="anchor" name="6f62d77b0451737114b5a10bf23be21e"></a><!-- doxytag: member="VISU::Result::GetType" ref="6f62d77b0451737114b5a10bf23be21e" args="()" --><p>
 371 <table class="mdTable" cellpadding="2" cellspacing="0">
 372   <tr>
 373     <td class="mdRow">
 374       <table cellpadding="0" cellspacing="0" border="0">
 375         <tr>
 376           <td class="md" nowrap valign="top">VISUType VISU.Base.GetType           </td>
 377           <td class="md" valign="top">(&nbsp;</td>
 378           <td class="mdname1" valign="top" nowrap>          </td>
 379           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 380           <td class="md" nowrap><code> [inherited]</code></td>
 381         </tr>
 382       </table>
 383     </td>
 384   </tr>
 385 </table>
 386 <table cellspacing="5" cellpadding="0" border="0">
 387   <tr>
 388     <td>
 389       &nbsp;
 390     </td>
 391     <td>
 392
 393 <p>
 394 Returns the type of the presentable object     </td>
 395   </tr>
 396 </table>
 397 </DIV>
 398 </BODY>
 399 </HTML>