]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMESH_I/SMESH_Group_i.hxx
Salome HOME
Porting documentation on the Doxygen-1.8.0
[modules/smesh.git] / src / SMESH_I / SMESH_Group_i.hxx
1 // Copyright (C) 2007-2011  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.
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 //  SMESH SMESH_I : idl implementation based on 'SMESH' unit's classes
24 //  File   : SMESH_Group_i.hxx
25 //  Author : Sergey ANIKIN, OCC
26 //  Module : SMESH
27 //
28 #ifndef SMESH_Group_i_HeaderFile
29 #define SMESH_Group_i_HeaderFile
30
31 #include "SMESH.hxx"
32 #include "SMESH_Mesh_i.hxx"
33 #include "SMESH_Filter_i.hxx"
34
35 #include <SALOMEconfig.h>
36 #include CORBA_SERVER_HEADER(SMESH_Group)
37 #include CORBA_SERVER_HEADER(SMESH_Mesh)
38 #include CORBA_CLIENT_HEADER(GEOM_Gen)
39
40 #include "SALOME_GenericObj_i.hh"
41
42 class SMESH_Group;
43 class SMESHDS_GroupBase;
44 class SMESH_PreMeshInfo;
45
46 // ===========
47 // Group Base
48 // ===========
49 class SMESH_I_EXPORT SMESH_GroupBase_i:
50   public virtual POA_SMESH::SMESH_GroupBase,
51   public virtual SALOME::GenericObj_i
52 {
53  public:
54   SMESH_GroupBase_i(PortableServer::POA_ptr thePOA,
55                     SMESH_Mesh_i*           theMeshServant,
56                     const int               theLocalID );
57   virtual ~SMESH_GroupBase_i();
58
59   // CORBA interface implementation
60   void SetName(const char* name);
61   char* GetName();
62   SMESH::ElementType GetType();
63   CORBA::Long Size();
64   CORBA::Boolean IsEmpty();
65   CORBA::Boolean Contains(CORBA::Long elem_id);
66   CORBA::Long GetID(CORBA::Long elem_index);
67   SMESH::long_array* GetListOfID();
68   SMESH::long_array* GetNodeIDs();
69   CORBA::Long GetNumberOfNodes();
70   CORBA::Boolean IsNodeInfoAvailable(); // for gui
71
72   virtual SMESH::SMESH_Mesh_ptr GetMesh();
73
74   /*!
75    * Returns statistic of mesh elements
76    * Result array of number enityties
77    * Inherited from SMESH_IDSource
78    */
79   virtual SMESH::long_array* GetMeshInfo();
80
81   // Inherited from SMESH_IDSource interface
82   virtual SMESH::long_array* GetIDs();
83
84   /*!
85    * Returns types of elements it contains
86    * Inherited from SMESH_IDSource interface
87    */
88   virtual SMESH::array_of_ElementType* GetTypes();
89   /*!
90    * Returns false if GetMeshInfo() returns incorrect information that may
91    * happen if mesh data is not yet fully loaded from the file of study.
92    */
93   virtual bool IsMeshInfoCorrect();
94
95   // Internal C++ interface
96   int GetLocalID() const { return myLocalID; }
97   SMESH_Mesh_i* GetMeshServant() const { return myMeshServant; }
98   SMESH_Group* GetSmeshGroup() const;
99   SMESHDS_GroupBase* GetGroupDS() const;
100
101   void SetColor(const SALOMEDS::Color& color);
102   SALOMEDS::Color GetColor();
103
104   void SetColorNumber(CORBA::Long color);
105   CORBA::Long GetColorNumber();
106
107 protected:
108
109   SMESH_PreMeshInfo* & changePreMeshInfo() { return myPreMeshInfo; }
110   SMESH_PreMeshInfo* myPreMeshInfo; // mesh info before full loading from study file
111   friend class SMESH_PreMeshInfo;
112
113 private:
114   SMESH_Mesh_i* myMeshServant;
115   int myLocalID;
116
117   void changeLocalId(int localId) { myLocalID = localId; }
118   friend class SMESH_Mesh_i;
119
120   int myNbNodes, myGroupDSTic;
121 };
122
123 // ======
124 // Group
125 // ======
126
127 class SMESH_I_EXPORT SMESH_Group_i:
128   public virtual POA_SMESH::SMESH_Group,
129   public SMESH_GroupBase_i
130 {
131  public:
132   SMESH_Group_i( PortableServer::POA_ptr thePOA,
133                  SMESH_Mesh_i*           theMeshServant,
134                  const int               theLocalID );
135   // CORBA interface implementation
136   void Clear();
137   CORBA::Long Add( const SMESH::long_array& theIDs );
138   CORBA::Long Remove( const SMESH::long_array& theIDs );
139
140   CORBA::Long AddByPredicate( SMESH::Predicate_ptr thePredicate );
141   CORBA::Long RemoveByPredicate( SMESH::Predicate_ptr thePredicate );
142
143   CORBA::Long AddFrom( SMESH::SMESH_IDSource_ptr theSource );
144 };
145
146 // =========================
147 // Group linked to geometry
148 // =========================
149
150 class SMESH_I_EXPORT SMESH_GroupOnGeom_i:
151   public virtual POA_SMESH::SMESH_GroupOnGeom,
152   public SMESH_GroupBase_i
153 {
154  public:
155   SMESH_GroupOnGeom_i( PortableServer::POA_ptr thePOA,
156                        SMESH_Mesh_i*           theMeshServant,
157                        const int               theLocalID );
158   // CORBA interface implementation
159   GEOM::GEOM_Object_ptr GetShape();
160 };
161
162 // =========================
163 // Group deined by filter
164 // =========================
165
166 class SMESH_I_EXPORT SMESH_GroupOnFilter_i:
167   public virtual POA_SMESH::SMESH_GroupOnFilter,
168   public SMESH_GroupBase_i,
169   public SMESH::Filter_i::TPredicateChangeWaiter
170 {
171  public:
172   SMESH_GroupOnFilter_i( PortableServer::POA_ptr thePOA,
173                          SMESH_Mesh_i*           theMeshServant,
174                          const int               theLocalID );
175   ~SMESH_GroupOnFilter_i();
176
177   // Persistence
178   static SMESH::Filter_ptr StringToFilter(const std::string& thePersistentString );
179   std::string FilterToString() const;
180
181   static SMESH_PredicatePtr GetPredicate( SMESH::Filter_ptr );
182
183   // CORBA interface implementation
184   void SetFilter(SMESH::Filter_ptr theFilter);
185   SMESH::Filter_ptr GetFilter();
186
187   // method of SMESH::Filter_i::TPredicateChangeWaiter
188   virtual void PredicateChanged();
189
190  private:
191   SMESH::Filter_var myFilter;
192 };
193 #endif