SMESH_Group.idl

Go to the documentation of this file.

// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

//  File   : SMESH_Group.idl
//  Author : Sergey ANIKIN, OCC
//  $Header$
//
#ifndef _SMESH_GROUP_IDL_
#define _SMESH_GROUP_IDL_

#include "SALOME_Exception.idl"
#include "SALOME_GenericObj.idl"
#include "SALOMEDS_Attributes.idl"

#include "SMESH_Mesh.idl"

module SMESH
{
  interface Predicate;
  interface Filter;

  interface SMESH_GroupBase : SALOME::GenericObj, SMESH_IDSource
  {
    void SetName( in string name );

    string GetName();

    ElementType GetType();

    long Size();

    boolean IsEmpty();

    boolean Contains( in long elem_id );

    long GetID( in long elem_index );

    long_array GetListOfID();

    long GetNumberOfNodes();

    long_array GetNodeIDs();

    boolean IsNodeInfoAvailable();

    void SetColor(in SALOMEDS::Color theColor);

    SALOMEDS::Color GetColor();

    void SetColorNumber( in long color );

    long GetColorNumber();

    boolean IsInDependency( in SMESH_GroupBase other );
  };

  interface SMESH_Group : SMESH_GroupBase
  {
    void Clear();

    long Add( in long_array elem_ids );
    long AddByPredicate( in Predicate thePredicate );
    long AddFrom( in SMESH_IDSource theSource );

    long Remove( in long_array elem_ids );
    long RemoveByPredicate( in Predicate thePredicate );

  };

  interface SMESH_GroupOnGeom : SMESH_GroupBase
  {
    GEOM::GEOM_Object GetShape();
  };

  interface SMESH_GroupOnFilter : SMESH_GroupBase
  {
    void   SetFilter( in Filter theFilter) raises (SALOME::SALOME_Exception); 
    Filter GetFilter();
  };

};


#endif