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 #ifndef _SMESH_GROUP_IDL_
  26 #define _SMESH_GROUP_IDL_
  27
  28 #include "SALOME_Exception.idl"
  29 #include "SALOME_GenericObj.idl"
  30
  31 #include "SMESH_Mesh.idl"
  32
  33 module SMESH
  34 {
  35   /*!
  36    * SMESH_Group: interface of group object
  37    */
  38   interface SMESH_Group : SALOME::GenericObj
  39   {
  40     /*!
  41      * Sets group name
  42      */
  43     void SetName( in string name );
  44
  45     /*!
  46      * Returns group name
  47      */
  48     string GetName();
  49
  50     /*!
  51      * Returns group type (type of elements in the group)
  52      */
  53     ElementType GetType();
  54
  55     /*!
  56      * Returns the number of elements in the group
  57      */
  58     long Size();
  59
  60     /*!
  61      * Returns true if the group does not contain any elements
  62      */
  63     boolean IsEmpty();
  64
  65     /*!
  66      * Clears the group's contents
  67      */
  68     void Clear();
  69
  70     /*!
  71      * returns true if the group contains an element with ID == <elem_id>
  72      */
  73     boolean Contains( in long elem_id );
  74
  75     /*!
  76      * Adds elements to the group
  77      */
  78     long Add( in long_array elem_ids );
  79
  80     /*!
  81      * Returns ID of an element at position <elem_index>
  82      */
  83     long GetID( in long elem_index );
  84
  85     /*!
  86      * Returns a sequence of all element IDs in the group
  87      */
  88     long_array GetListOfID();
  89
  90     /*!
  91      * Removes elements from the group
  92      */
  93     long Remove( in long_array elem_ids );
  94
  95     /*!
  96      * Returns the mesh object this group belongs to
  97      */
  98     SMESH_Mesh GetMesh();
  99   };
 100 };
 101
 102
 103 #endif