0021308: Remove hard-coded dependency of the external mesh plugins from the SMESH...

[modules/smesh.git] / idl / SMESH_Group.idl

diff --git a/idl/SMESH_Group.idl b/idl/SMESH_Group.idl
index c0bb54bc9ab15cb2429fc1a4167c5be9fcf3a2ab..863f42823bb319b46c72c105860892fd0138cb87 100644 (file)
--- a/idl/SMESH_Group.idl
+++ b/idl/SMESH_Group.idl
@@ -1,23 +1,23 @@
-//  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
-//  This library is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU Lesser General Public
-//  License as published by the Free Software Foundation; either
-//  version 2.1 of the License.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
 //
-//  This library is distributed in the hope that it will be useful,
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-//  Lesser General Public License for more details.
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
-//  You should have received a copy of the GNU Lesser General Public
-//  License along with this library; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 //  File   : SMESH_Group.idl
@@ -36,6 +36,7 @@
 module SMESH
 {
   interface Predicate;
+  interface Filter;
 
   /*!
    * SMESH_Group: base interface of group object
@@ -83,9 +84,21 @@ module SMESH
     long_array GetListOfID();
 
     /*!
-     * Returns the mesh object this group belongs to
+     * Get the number of nodes of cells included to the group
+     * For a nodal group returns the same value as Size() function
      */
-    SMESH_Mesh GetMesh();
+    long GetNumberOfNodes();
+
+    /*!
+     * Get IDs of nodes of cells included to the group
+     * For a nodal group returns result of GetListOfID() function
+     */
+    long_array GetNodeIDs();
+
+    /*!
+     * Return true if GetNumberOfNodes() won't take a long time for computation
+     */
+    boolean IsNodeInfoAvailable();
 
     /*!
      * Sets group color
@@ -111,7 +124,7 @@ module SMESH
   }; 
 
   /*!
-   * SMESH_Group: interface of group object
+   * SMESH_Group: interface of a standalone group object
    */
   interface SMESH_Group : SMESH_GroupBase
   {
@@ -121,26 +134,46 @@ module SMESH
     void Clear();
 
     /*!
-     * Adds elements to the group
+     * Adds elements or nodes with specified identifiers to the group
      */
     long Add( in long_array elem_ids );
+    /*!
+     * Adds elements or nodes that match specified predicate to the group
+     */
     long AddByPredicate( in Predicate thePredicate );
+    /*!
+     * Add all elements or nodes from the specified source to the group
+     */
+    long AddFrom( in SMESH_IDSource theSource );
 
     /*!
-     * Removes elements from the group
+     * Removes elements or nodes with specified identifiers from the group
      */
     long Remove( in long_array elem_ids );
+    /*!
+     * Removes elements or nodes that match specified predicate from the group
+     */
     long RemoveByPredicate( in Predicate thePredicate );
 
   };
+
   /*!
-   * SMESH_Group: interface of group object linked to geometry
+   * SMESH_GroupOnGeom: interface of a group object linked to geometry
    */
   interface SMESH_GroupOnGeom : SMESH_GroupBase
   {
     GEOM::GEOM_Object GetShape();
   };
 
+  /*!
+   * SMESH_GroupOnFilter: interface of a group object defined by filter
+   */
+  interface SMESH_GroupOnFilter : SMESH_GroupBase
+  {
+    void   SetFilter( in Filter theFilter); 
+    Filter GetFilter();
+  };
+
 };