Salome HOME
Update of the documentation of the plugin "blocfissure"
[modules/smesh.git] / idl / SMESH_Group.idl
1 // Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  File   : SMESH_Group.idl
24 //  Author : Sergey ANIKIN, OCC
25 //  $Header$
26 //
27 #ifndef _SMESH_GROUP_IDL_
28 #define _SMESH_GROUP_IDL_
29
30 #include "SALOME_Exception.idl"
31 #include "SALOME_GenericObj.idl"
32 #include "SALOMEDS_Attributes.idl"
33
34 #include "SMESH_Mesh.idl"
35
36 module SMESH
37 {
38   interface Predicate;
39   interface Filter;
40
41   /*!
42    * SMESH_Group: base interface of group object
43    */
44   interface SMESH_GroupBase : SMESH_IDSource
45   {
46     /*!
47      * Sets group name
48      */
49     void SetName( in string name );
50
51     /*!
52      * Returns group name
53      */
54     string GetName();
55
56     /*!
57      * Returns group type (type of elements in the group)
58      */
59     ElementType GetType();
60
61     /*!
62      * Returns the number of elements in the group
63      */
64     long Size();
65
66     /*!
67      * Returns true if the group does not contain any elements
68      */
69     boolean IsEmpty();
70
71     /*!
72      * returns true if the group contains an element with ID == <elem_id> 
73      */
74     boolean Contains( in long elem_id );
75
76     /*!
77      * Returns ID of an element at position <elem_index> counted from 1
78      */
79     long GetID( in long elem_index );
80
81     /*!
82      * Returns a sequence of all element IDs in the group
83      */
84     long_array GetListOfID();
85
86     /*!
87      * Get the number of nodes of cells included to the group
88      * For a nodal group returns the same value as Size() function
89      */
90     long GetNumberOfNodes();
91
92     /*!
93      * Get IDs of nodes of cells included to the group
94      * For a nodal group returns result of GetListOfID() function
95      */
96     long_array GetNodeIDs();
97
98     /*!
99      * Return true if GetNumberOfNodes() won't take a long time for computation
100      */
101     boolean IsNodeInfoAvailable();
102
103     /*!
104      * Sets group color
105      */
106     void SetColor(in SALOMEDS::Color theColor);
107
108     /*!
109      * Returns group color
110      */
111     SALOMEDS::Color GetColor();
112
113     /*!
114      * Sets group color number
115      * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
116      */
117     void SetColorNumber( in long color );
118
119     /*!
120      * Returns group color number (obsolete - use GetColor instead)
121      * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
122      */
123     long GetColorNumber();
124
125     /*!
126      * Returns \c true if \c this group depends on the \a other via
127      * FT_BelongToMeshGroup predicate or vice versa
128      */
129     boolean IsInDependency( in SMESH_GroupBase other );
130   };
131
132   /*!
133    * SMESH_Group: interface of a standalone group object
134    */
135   interface SMESH_Group : SMESH_GroupBase
136   {
137     /*!
138      * Clears the group's contents
139      */
140     void Clear();
141
142     /*!
143      * Adds elements or nodes with specified identifiers to the group
144      */
145     long Add( in long_array elem_ids );
146     /*!
147      * Adds elements or nodes that match specified predicate to the group
148      */
149     long AddByPredicate( in Predicate thePredicate );
150     /*!
151      * Add all elements or nodes from the specified source to the group
152      */
153     long AddFrom( in SMESH_IDSource theSource );
154
155     /*!
156      * Removes elements or nodes with specified identifiers from the group
157      */
158     long Remove( in long_array elem_ids );
159     /*!
160      * Removes elements or nodes that match specified predicate from the group
161      */
162     long RemoveByPredicate( in Predicate thePredicate );
163
164   };
165
166   /*!
167    * SMESH_GroupOnGeom: interface of a group object linked to geometry
168    */
169   interface SMESH_GroupOnGeom : SMESH_GroupBase
170   {
171     GEOM::GEOM_Object GetShape();
172   };
173
174   /*!
175    * SMESH_GroupOnFilter: interface of a group object defined by filter
176    */
177   interface SMESH_GroupOnFilter : SMESH_GroupBase
178   {
179     void   SetFilter( in Filter theFilter) raises (SALOME::SALOME_Exception); 
180     Filter GetFilter();
181
182     //! @return True if group contents is computed
183     boolean IsUpToDate();
184   };
185
186 };
187
188
189 #endif