Version: 9.12.0
SMESH_Group.idl
Go to the documentation of this file.
1 // Copyright (C) 2007-2023 CEA, EDF, 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 #include "SMESH_smIdType.idl"
36 
37 module SMESH
38 {
39  interface Predicate;
40  interface Filter;
41 
46  {
50  void SetName( in string name );
51 
55  string GetName();
56 
61 
65  smIdType Size();
66 
70  boolean IsEmpty();
71 
75  boolean Contains( in smIdType elem_id );
76 
80  smIdType GetID( in smIdType elem_index );
81 
86 
91  smIdType GetNumberOfNodes();
92 
98 
103 
107  void SetColor(in SALOMEDS::Color theColor);
108 
112  SALOMEDS::Color GetColor();
113 
118  void SetColorNumber( in long color );
119 
125 
130  boolean IsInDependency( in SMESH_GroupBase other );
131  };
132 
137  {
141  void Clear();
142 
146  smIdType Add( in smIdType_array elem_ids );
150  smIdType AddByPredicate( in Predicate thePredicate );
154  smIdType AddFrom( in SMESH_IDSource theSource );
155 
159  smIdType Remove( in smIdType_array elem_ids );
163  smIdType RemoveByPredicate( in Predicate thePredicate );
164 
165  };
166 
171  {
172  GEOM::GEOM_Object GetShape();
173  };
174 
179  {
180  void SetFilter( in Filter theFilter) raises (SALOME::SALOME_Exception);
182 
184  boolean IsUpToDate();
185  };
186 
187 };
188 
189 
190 #endif
Filter.
Definition: SMESH_Filter.idl:490
Predicates are intended for verification of criteria, they return bool value by mesh id.
Definition: SMESH_Filter.idl:182
SMESH_Group: base interface of group object.
Definition: SMESH_Group.idl:46
smIdType_array GetListOfID()
Returns a sequence of all element IDs in the group.
SALOMEDS::Color GetColor()
Returns group color.
boolean Contains(in smIdType elem_id)
returns true if the group contains an element with ID == <elem_id>
boolean IsEmpty()
Returns true if the group does not contain any elements.
string GetName()
Returns group name.
void SetColorNumber(in long color)
Sets group color number (corresponds to the "hue" parameter of the color - must be in range [0,...
smIdType Size()
Returns the number of elements in the group.
boolean IsInDependency(in SMESH_GroupBase other)
Returns true if this group depends on the other via FT_BelongToMeshGroup predicate or vice versa.
ElementType GetType()
Returns group type (type of elements in the group)
boolean IsNodeInfoAvailable()
Return true if GetNumberOfNodes() won't take a long time for computation.
smIdType_array GetNodeIDs()
Get IDs of nodes of cells included to the group For a nodal group returns result of GetListOfID() fun...
smIdType GetNumberOfNodes()
Get the number of nodes of cells included to the group For a nodal group returns the same value as Si...
long GetColorNumber()
Returns group color number (obsolete - use GetColor instead) (corresponds to the "hue" parameter of t...
void SetName(in string name)
Sets group name.
smIdType GetID(in smIdType elem_index)
Returns ID of an element at position <elem_index> counted from 1.
void SetColor(in SALOMEDS::Color theColor)
Sets group color.
SMESH_GroupOnFilter: interface of a group object defined by filter.
Definition: SMESH_Group.idl:179
void SetFilter(in Filter theFilter)
SMESH_GroupOnGeom: interface of a group object linked to geometry.
Definition: SMESH_Group.idl:171
GEOM::GEOM_Object GetShape()
SMESH_Group: interface of a standalone group object.
Definition: SMESH_Group.idl:137
smIdType AddFrom(in SMESH_IDSource theSource)
Add all elements or nodes from the specified source to the group.
smIdType Add(in smIdType_array elem_ids)
Adds elements or nodes with specified identifiers to the group.
smIdType AddByPredicate(in Predicate thePredicate)
Adds elements or nodes that match specified predicate to the group.
smIdType Remove(in smIdType_array elem_ids)
Removes elements or nodes with specified identifiers from the group.
smIdType RemoveByPredicate(in Predicate thePredicate)
Removes elements or nodes that match specified predicate from the group.
void Clear()
Clears the group's contents.
Definition: SMESH_Mesh.idl:286
Definition: SMESH_ControlsDef.hxx:64
sequence< smIdType > smIdType_array
Definition: SMESH_Mesh.idl:45
ElementType
Enumeration for element type, like in SMDS.
Definition: SMESH_Mesh.idl:128