]> SALOME platform Git repositories - modules/visu.git/commitdiff
Salome HOME
Intorduce comments for IDL methods
authorapo <apo@opencascade.com>
Thu, 30 Nov 2006 09:14:32 +0000 (09:14 +0000)
committerapo <apo@opencascade.com>
Thu, 30 Nov 2006 09:14:32 +0000 (09:14 +0000)
idl/VISU_Gen.idl

index a45623af77d55582a30870916d9c48bb206c1463..252bfad691f55b4c44f9109b4025155bce05840d 100644 (file)
@@ -314,7 +314,8 @@ module VISU {
    *
    * This is a root class for all 3D presentations, which can be displayed in %VISU module.
    */
-  interface Prs3d : PrsObject, SALOME::GenericObj {
+  interface Prs3d : PrsObject, SALOME::GenericObj 
+  {
     /*!
      * Applies a set basic input parameters to the 3D presentation
      * \return True of the set of input parameters is correct and was succesfully applied,
@@ -322,10 +323,16 @@ module VISU {
      */
     boolean Apply(); 
 
+    //! Sets Result object used by presentation to obtain its input 
     void SetResultObject(in Result theResult);
+
+    //! Gets Result object used by presentation to obtain its input 
     Result GetResultObject();
 
+    //! Sets name of the mesh used by presentation to obtain its input 
     void SetMeshName(in string theMeshName);
+
+    //! Gets name of the mesh used by presentation to obtain its input 
     string GetMeshName();
 
     /*!
@@ -338,6 +345,11 @@ module VISU {
      * Gets offset parameters for the 3D presentation
      */
     void GetOffset(out float theDx, out float theDy, out float theDz);
+
+    /*!
+     * Gets memory size actually used by the presentation (Mb).
+     */
+    float GetMemorySize();
   };
 
   /*!
@@ -566,11 +578,6 @@ module VISU {
      * Gets the title of the scalar bar.
      */
     string GetTitle();
-    
-    /*!
-     * Gets an expended memory size for the presentation (Mb).
-     */
-    float GetMemorySize();
   };
 
 
@@ -657,7 +664,7 @@ module VISU {
     float GetLimitedMemory();
 
     /*!
-     * Gets an expended memory size for the cache system (Mb).
+     * Gets memory size actually used by the cache system (Mb).
      */
     float GetMemorySize();