Salome HOME
Implementation of 'GetEntriesToCleanStudy' function to get categorized lists of objects.
[modules/geom.git] / idl / GEOM_Gen.idl
index 01187280ddd80a8cf55c5acb17ab381b349431d6..a0f2020de211224951677bef3a29c13f56f7ded8 100644 (file)
@@ -5091,17 +5091,32 @@ module GEOM
               in long row );
 
     /*!
-     * \brief Get dependencies of the given object from other objects in study
-     * \param list of IORs
-     * \return texture byte array
-     * Example of using: 
-     *   SALOMEDS::TMPFile_var SeqFile = 
-     *     myGeometryGUI->GetGeomGen()->GetDependencyTree( aStudy, aListOfIORs );
-     *   char* buf;
-     *   buf = (char*) &SeqFile[0];
+     * \brief Collects dependencies of the given objects from other ones
+     * \param theStudy The study in which the object is published
+     * \param theListOfEntries List of GEOM object entries in OCAF tree (not in study)
+     * \return Struct of dependent entries and its links as a byte array
+     * \note This method is supposed to be used by GUI only.
      */
     SALOMEDS::TMPFile GetDependencyTree(in SALOMEDS::Study theStudy,
-                                       in string_array strValues);
+                                       in string_array theListOfEntries);
+
+    /*!
+     * \brief Fills 3 lists that is used to clean study of redundant objects:
+     *  - dependencies of the given objects from other ones;
+     *  - children of the given objects;
+     *  - all other objects in study.
+     * \param theStudy The study in which the object was published
+     * \param theSelectedEntries List of GEOM object entries in OCAF tree
+     * \param theParentEntries List of GEOM object entries on which the given objects depend
+     * \param theSubEntries Children entries list of the given objects
+     * \param theOtherEntries List of GEOM object entries which are in the study, but not in parents and children lists
+     * \note This method is supposed to be used by GUI only.
+     */
+    void GetEntriesToCleanStudy(in SALOMEDS::Study theStudy,
+                               inout string_array theSelectedEntries,
+                               inout string_array theParentEntries,
+                               inout string_array theSubEntries,
+                               inout string_array theOtherEntries);
 
   };
 };