idl/SMESH_Group.idl

   1 // Copyright (C) 2007-2024  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
  42   /*!
  43    * SMESH_Group: base interface of group object
  44    */
  45   interface SMESH_GroupBase : SMESH_IDSource
  46   {
  47     /*!
  48      * Sets group name
  49      */
  50     void SetName( in string name );
  51
  52     /*!
  53      * Returns group name
  54      */
  55     string GetName();
  56
  57     /*!
  58      * Returns group type (type of elements in the group)
  59      */
  60     ElementType GetType();
  61
  62     /*!
  63      * Returns the number of elements in the group
  64      */
  65     smIdType Size();
  66
  67     /*!
  68      * Returns true if the group does not contain any elements
  69      */
  70     boolean IsEmpty();
  71
  72     /*!
  73      * returns true if the group contains an element with ID == <elem_id>
  74      */
  75     boolean Contains( in smIdType elem_id );
  76
  77     /*!
  78      * Returns ID of an element at position <elem_index> counted from 1
  79      */
  80     smIdType GetID( in smIdType elem_index );
  81
  82     /*!
  83      * Returns a sequence of all element IDs in the group
  84      */
  85     smIdType_array GetListOfID();
  86
  87     /*!
  88      * Get the number of nodes of cells included to the group
  89      * For a nodal group returns the same value as Size() function
  90      */
  91     smIdType GetNumberOfNodes();
  92
  93     /*!
  94      * Get IDs of nodes of cells included to the group
  95      * For a nodal group returns result of GetListOfID() function
  96      */
  97     smIdType_array GetNodeIDs();
  98
  99     /*!
 100      * Return true if GetNumberOfNodes() won't take a long time for computation
 101      */
 102     boolean IsNodeInfoAvailable();
 103
 104     /*!
 105      * Sets group color
 106      */
 107     void SetColor(in SALOMEDS::Color theColor);
 108
 109     /*!
 110      * Returns group color
 111      */
 112     SALOMEDS::Color GetColor();
 113
 114     /*!
 115      * Sets group color number
 116      * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
 117      */
 118     void SetColorNumber( in long color );
 119
 120     /*!
 121      * Returns group color number (obsolete - use GetColor instead)
 122      * (corresponds to the "hue" parameter of the color - must be in range [0, 360])
 123      */
 124     long GetColorNumber();
 125
 126     /*!
 127      * Returns \c true if \c this group depends on the \a other via
 128      * FT_BelongToMeshGroup predicate or vice versa
 129      */
 130     boolean IsInDependency( in SMESH_GroupBase other );
 131   };
 132
 133   /*!
 134    * SMESH_Group: interface of a standalone group object
 135    */
 136   interface SMESH_Group : SMESH_GroupBase
 137   {
 138     /*!
 139      * Clears the group's contents
 140      */
 141     void Clear();
 142
 143     /*!
 144      * Adds elements or nodes with specified identifiers to the group
 145      */
 146     smIdType Add( in smIdType_array elem_ids );
 147     /*!
 148      * Adds elements or nodes that match specified predicate to the group
 149      */
 150     smIdType AddByPredicate( in Predicate thePredicate );
 151     /*!
 152      * Add all elements or nodes from the specified source to the group
 153      */
 154     smIdType AddFrom( in SMESH_IDSource theSource );
 155
 156     /*!
 157      * Removes elements or nodes with specified identifiers from the group
 158      */
 159     smIdType Remove( in smIdType_array elem_ids );
 160     /*!
 161      * Removes elements or nodes that match specified predicate from the group
 162      */
 163     smIdType RemoveByPredicate( in Predicate thePredicate );
 164
 165   };
 166
 167   /*!
 168    * SMESH_GroupOnGeom: interface of a group object linked to geometry
 169    */
 170   interface SMESH_GroupOnGeom : SMESH_GroupBase
 171   {
 172     GEOM::GEOM_Object GetShape();
 173   };
 174
 175   /*!
 176    * SMESH_GroupOnFilter: interface of a group object defined by filter
 177    */
 178   interface SMESH_GroupOnFilter : SMESH_GroupBase
 179   {
 180     void   SetFilter( in Filter theFilter) raises (SALOME::SALOME_Exception);
 181     Filter GetFilter();
 182
 183     //! @return True if group contents is computed
 184     boolean IsUpToDate();
 185   };
 186
 187 };
 188
 189
 190 #endif