Salome HOME
fix bug 12361. In SetName(): there may be no study
[modules/smesh.git] / idl / SMESH_Group.idl
1 //  Copyright (C) 2004  CEA 
2 // 
3 //  This library is free software; you can redistribute it and/or 
4 //  modify it under the terms of the GNU Lesser General Public 
5 //  License as published by the Free Software Foundation; either 
6 //  version 2.1 of the License. 
7 // 
8 //  This library is distributed in the hope that it will be useful, 
9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of 
10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
11 //  Lesser General Public License for more details. 
12 // 
13 //  You should have received a copy of the GNU Lesser General Public 
14 //  License along with this library; if not, write to the Free Software 
15 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
16 // 
17 //  See http://www.salome-platform.org or email : webmaster.salome@opencascade.org 
18 //
19 //
20 //
21 //  File   : SMESH_Group.idl
22 //  Author : Sergey ANIKIN, OCC
23 //  $Header$
24
25
26 #ifndef _SMESH_GROUP_IDL_
27 #define _SMESH_GROUP_IDL_
28
29 #include "SALOME_Exception.idl"
30 #include "SALOME_GenericObj.idl"
31
32 #include "SMESH_Mesh.idl"
33
34 module SMESH
35 {
36   interface Predicate;
37
38   /*!
39    * SMESH_Group: base interface of group object
40    */
41   interface SMESH_GroupBase : SALOME::GenericObj, SMESH_IDSource
42   {
43     /*!
44      * Sets group name
45      */
46     void SetName( in string name );
47
48     /*!
49      * Returns group name
50      */
51     string GetName();
52
53     /*!
54      * Returns group type (type of elements in the group)
55      */
56     ElementType GetType();
57
58     /*!
59      * Returns the number of elements in the group
60      */
61     long Size();
62
63     /*!
64      * Returns true if the group does not contain any elements
65      */
66     boolean IsEmpty();
67
68     /*!
69      * returns true if the group contains an element with ID == <elem_id> 
70      */
71     boolean Contains( in long elem_id );
72
73     /*!
74      * Returns ID of an element at position <elem_index>
75      */
76     long GetID( in long elem_index );
77
78     /*!
79      * Returns a sequence of all element IDs in the group
80      */
81     long_array GetListOfID();
82
83     /*!
84      * Returns the mesh object this group belongs to
85      */
86     SMESH_Mesh GetMesh();
87
88     /*!
89      * Sets group color number
90      */
91     void SetColorNumber( in long color );
92
93     /*!
94      * Returns group color number
95      */
96     long GetColorNumber();
97   }; 
98
99   /*!
100    * SMESH_Group: interface of group object
101    */
102   interface SMESH_Group : SMESH_GroupBase
103   {
104     /*!
105      * Clears the group's contents
106      */
107     void Clear();
108
109     /*!
110      * Adds elements to the group
111      */
112     long Add( in long_array elem_ids );
113     long AddByPredicate( in Predicate thePredicate );
114
115     /*!
116      * Removes elements from the group
117      */
118     long Remove( in long_array elem_ids );
119     long RemoveByPredicate( in Predicate thePredicate );
120
121   };
122   /*!
123    * SMESH_Group: interface of group object linked to geometry
124    */
125   interface SMESH_GroupOnGeom : SMESH_GroupBase
126   {
127     GEOM::GEOM_Object GetShape();
128   };
129
130 };
131
132
133 #endif