doc/salome/gui/VISU/visugenidl_doc/interfaceVISU_1_1Container.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.Container Interface Reference</h1><!-- doxytag: class="VISU::Container" --><!-- doxytag: inherits="VISU::PrsObject" -->Container presentable object interface
  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.Container:<p><center><img src="interfaceVISU_1_1Container__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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Container.html#313192ea8431ad0a5c30331bbf1a2a5d">AddCurve</a> (in <a class="el" href="interfaceVISU_1_1Curve.html">Curve</a> theCurve)</td></tr>
  24
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Container.html#70ad8fdee09c462b363b61a1202cc59d">RemoveCurve</a> (in <a class="el" href="interfaceVISU_1_1Curve.html">Curve</a> theCurve)</td></tr>
  26
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Container.html#56c69bf2a6e02e5ecf552b7d9023c8a0">GetNbCurves</a> ()</td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Container.html#f5214ab7eaf5db6cda15707cdb8170d8">Clear</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_1RemovableObject.html#7d053f4324b26edd325024cd45424f13">RemoveFromStudy</a> ()</td></tr>
  32
  33 <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>
  34
  35 <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>
  36
  37 </table>
  38 <hr><a name="_details"></a><h2>Detailed Description</h2>
  39 This class is provided in order to create one presentation using several presentable objects. This can provide a combination of a set of curves to display them in XY plot view.
  40 <p>
  41 <hr><h2>Member Function Documentation</h2>
  42 <a class="anchor" name="313192ea8431ad0a5c30331bbf1a2a5d"></a><!-- doxytag: member="VISU::Container::AddCurve" ref="313192ea8431ad0a5c30331bbf1a2a5d" args="(in Curve theCurve)" --><p>
  43 <table class="mdTable" cellpadding="2" cellspacing="0">
  44   <tr>
  45     <td class="mdRow">
  46       <table cellpadding="0" cellspacing="0" border="0">
  47         <tr>
  48           <td class="md" nowrap valign="top">void VISU.Container.AddCurve           </td>
  49           <td class="md" valign="top">(&nbsp;</td>
  50           <td class="md" nowrap valign="top">in <a class="el" href="interfaceVISU_1_1Curve.html">Curve</a>&nbsp;</td>
  51           <td class="mdname1" valign="top" nowrap> <em>theCurve</em>          </td>
  52           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  53           <td class="md" nowrap></td>
  54         </tr>
  55       </table>
  56     </td>
  57   </tr>
  58 </table>
  59 <table cellspacing="5" cellpadding="0" border="0">
  60   <tr>
  61     <td>
  62       &nbsp;
  63     </td>
  64     <td>
  65
  66 <p>
  67 Adds a curve into the container. <dl compact><dt><b>Parameters:</b></dt><dd>
  68   <table border="0" cellspacing="2" cellpadding="0">
  69     <tr><td valign="top"></td><td valign="top"><em>theCurve</em>&nbsp;</td><td>The added curve. </td></tr>
  70   </table>
  71 </dl>
  72     </td>
  73   </tr>
  74 </table>
  75 <a class="anchor" name="70ad8fdee09c462b363b61a1202cc59d"></a><!-- doxytag: member="VISU::Container::RemoveCurve" ref="70ad8fdee09c462b363b61a1202cc59d" args="(in Curve theCurve)" --><p>
  76 <table class="mdTable" cellpadding="2" cellspacing="0">
  77   <tr>
  78     <td class="mdRow">
  79       <table cellpadding="0" cellspacing="0" border="0">
  80         <tr>
  81           <td class="md" nowrap valign="top">void VISU.Container.RemoveCurve           </td>
  82           <td class="md" valign="top">(&nbsp;</td>
  83           <td class="md" nowrap valign="top">in <a class="el" href="interfaceVISU_1_1Curve.html">Curve</a>&nbsp;</td>
  84           <td class="mdname1" valign="top" nowrap> <em>theCurve</em>          </td>
  85           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  86           <td class="md" nowrap></td>
  87         </tr>
  88       </table>
  89     </td>
  90   </tr>
  91 </table>
  92 <table cellspacing="5" cellpadding="0" border="0">
  93   <tr>
  94     <td>
  95       &nbsp;
  96     </td>
  97     <td>
  98
  99 <p>
 100 Removes a curve from the container. <dl compact><dt><b>Parameters:</b></dt><dd>
 101   <table border="0" cellspacing="2" cellpadding="0">
 102     <tr><td valign="top"></td><td valign="top"><em>theCurve</em>&nbsp;</td><td>The removed curve. </td></tr>
 103   </table>
 104 </dl>
 105     </td>
 106   </tr>
 107 </table>
 108 <a class="anchor" name="56c69bf2a6e02e5ecf552b7d9023c8a0"></a><!-- doxytag: member="VISU::Container::GetNbCurves" ref="56c69bf2a6e02e5ecf552b7d9023c8a0" args="()" --><p>
 109 <table class="mdTable" cellpadding="2" cellspacing="0">
 110   <tr>
 111     <td class="mdRow">
 112       <table cellpadding="0" cellspacing="0" border="0">
 113         <tr>
 114           <td class="md" nowrap valign="top">long VISU.Container.GetNbCurves           </td>
 115           <td class="md" valign="top">(&nbsp;</td>
 116           <td class="mdname1" valign="top" nowrap>          </td>
 117           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 118           <td class="md" nowrap></td>
 119         </tr>
 120       </table>
 121     </td>
 122   </tr>
 123 </table>
 124 <table cellspacing="5" cellpadding="0" border="0">
 125   <tr>
 126     <td>
 127       &nbsp;
 128     </td>
 129     <td>
 130
 131 <p>
 132 Gets the number of curves which are stored in the container. <dl compact><dt><b>Returns:</b></dt><dd>A long value corresponding to the number of curves which are stored in the container. </dd></dl>
 133     </td>
 134   </tr>
 135 </table>
 136 <a class="anchor" name="f5214ab7eaf5db6cda15707cdb8170d8"></a><!-- doxytag: member="VISU::Container::Clear" ref="f5214ab7eaf5db6cda15707cdb8170d8" args="()" --><p>
 137 <table class="mdTable" cellpadding="2" cellspacing="0">
 138   <tr>
 139     <td class="mdRow">
 140       <table cellpadding="0" cellspacing="0" border="0">
 141         <tr>
 142           <td class="md" nowrap valign="top">void VISU.Container.Clear           </td>
 143           <td class="md" valign="top">(&nbsp;</td>
 144           <td class="mdname1" valign="top" nowrap>          </td>
 145           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 146           <td class="md" nowrap></td>
 147         </tr>
 148       </table>
 149     </td>
 150   </tr>
 151 </table>
 152 <table cellspacing="5" cellpadding="0" border="0">
 153   <tr>
 154     <td>
 155       &nbsp;
 156     </td>
 157     <td>
 158
 159 <p>
 160 Removes all curves from the container.     </td>
 161   </tr>
 162 </table>
 163 <a class="anchor" name="7d053f4324b26edd325024cd45424f13"></a><!-- doxytag: member="VISU::Container::RemoveFromStudy" ref="7d053f4324b26edd325024cd45424f13" args="()" --><p>
 164 <table class="mdTable" cellpadding="2" cellspacing="0">
 165   <tr>
 166     <td class="mdRow">
 167       <table cellpadding="0" cellspacing="0" border="0">
 168         <tr>
 169           <td class="md" nowrap valign="top">void VISU.RemovableObject.RemoveFromStudy           </td>
 170           <td class="md" valign="top">(&nbsp;</td>
 171           <td class="mdname1" valign="top" nowrap>          </td>
 172           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 173           <td class="md" nowrap><code> [inherited]</code></td>
 174         </tr>
 175       </table>
 176     </td>
 177   </tr>
 178 </table>
 179 <table cellspacing="5" cellpadding="0" border="0">
 180   <tr>
 181     <td>
 182       &nbsp;
 183     </td>
 184     <td>
 185
 186 <p>
 187 Remove object from study.     </td>
 188   </tr>
 189 </table>
 190 <a class="anchor" name="5da28cc23f3657dd24a3b8598319c522"></a><!-- doxytag: member="VISU::Container::GetID" ref="5da28cc23f3657dd24a3b8598319c522" args="()" --><p>
 191 <table class="mdTable" cellpadding="2" cellspacing="0">
 192   <tr>
 193     <td class="mdRow">
 194       <table cellpadding="0" cellspacing="0" border="0">
 195         <tr>
 196           <td class="md" nowrap valign="top">IdType VISU.Base.GetID           </td>
 197           <td class="md" valign="top">(&nbsp;</td>
 198           <td class="mdname1" valign="top" nowrap>          </td>
 199           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 200           <td class="md" nowrap><code> [inherited]</code></td>
 201         </tr>
 202       </table>
 203     </td>
 204   </tr>
 205 </table>
 206 <table cellspacing="5" cellpadding="0" border="0">
 207   <tr>
 208     <td>
 209       &nbsp;
 210     </td>
 211     <td>
 212
 213 <p>
 214 Returns ID of the object.     </td>
 215   </tr>
 216 </table>
 217 <a class="anchor" name="6f62d77b0451737114b5a10bf23be21e"></a><!-- doxytag: member="VISU::Container::GetType" ref="6f62d77b0451737114b5a10bf23be21e" args="()" --><p>
 218 <table class="mdTable" cellpadding="2" cellspacing="0">
 219   <tr>
 220     <td class="mdRow">
 221       <table cellpadding="0" cellspacing="0" border="0">
 222         <tr>
 223           <td class="md" nowrap valign="top">VISUType VISU.Base.GetType           </td>
 224           <td class="md" valign="top">(&nbsp;</td>
 225           <td class="mdname1" valign="top" nowrap>          </td>
 226           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 227           <td class="md" nowrap><code> [inherited]</code></td>
 228         </tr>
 229       </table>
 230     </td>
 231   </tr>
 232 </table>
 233 <table cellspacing="5" cellpadding="0" border="0">
 234   <tr>
 235     <td>
 236       &nbsp;
 237     </td>
 238     <td>
 239
 240 <p>
 241 Returns the type of the presentable object     </td>
 242   </tr>
 243 </table>
 244 </DIV>
 245 </BODY>
 246 </HTML>