Version: 9.12.0
SMESH_PythonDump.hxx
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 #ifndef _SMESH_PYTHONDUMP_HXX_
24 #define _SMESH_PYTHONDUMP_HXX_
25 
26 #include "SMESH.hxx"
27 
28 #include <SALOMEconfig.h>
29 #include CORBA_SERVER_HEADER(SMESH_Mesh)
30 #include CORBA_SERVER_HEADER(SMESH_MeshEditor)
31 #include CORBA_SERVER_HEADER(GEOM_Gen)
32 #include CORBA_SERVER_HEADER(SALOMEDS)
33 
34 #include <TCollection_AsciiString.hxx>
35 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
36 
37 #include <sstream>
38 #include <vector>
39 #include <set>
40 #include <list>
41 
42 class SMESH_Gen_i;
43 class SMESH_MeshEditor_i;
44 
45 // ===========================================================================================
51 // ===========================================================================================
52 
54 {
55 public:
67  static void
68  ConvertScript(std::list< TCollection_AsciiString >& theScriptLines,
69  Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
70  Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
71  std::set< TCollection_AsciiString >& theRemovedObjIDs,
72  const bool theHistoricalDump);
73 
78  static const char* SmeshpyName() { return "smesh"; }
79  static const char* GenName() { return "smesh"; }
80 };
81 
82 namespace SMESH
83 {
84  class FilterLibrary_i;
85  class FilterManager_i;
86  class Filter_i;
87  class Functor_i;
88  class Measurements_i;
89 
90  // ===========================================================================================
96  // ===========================================================================================
97 
99  {
100  std::vector< std::string > myVals;
101  bool myIsList;
102  TVar(CORBA::Double value);
103  TVar(CORBA::Long value);
104  TVar(CORBA::LongLong value);
105  TVar(CORBA::Short value);
106  TVar(const SMESH::double_array& value);
107  // string used to temporary quote variable names in order
108  // not to confuse variables with string arguments
109  static char Quote() { return '$'; }
110  // string preceding an entry of object storing the attribute holding var names
111  static const char* ObjPrefix() { return " # OBJ: "; }
112  };
113 
114  // ===========================================================================================
118  // ===========================================================================================
119 
121  {
122  std::ostringstream myStream;
123  static size_t myCounter;
124  int myVarsCounter; // counts stored TVar's
125  SMESH_Gen_i *mySmesh = nullptr;
126  public:
127  TPythonDump(SMESH_Gen_i *smesh);
128  TPythonDump();
129  virtual ~TPythonDump();
130 
131  TPythonDump&
132  operator<<(const TVar& theVariableValue);
133 
134  TPythonDump&
135  operator<<(long int theArg);
136 
137  TPythonDump&
138  operator<<(int theArg);
139 
140  TPythonDump&
141  operator<<(long long theArg);
142 
143  TPythonDump&
144  operator<<(double theArg);
145 
146  TPythonDump&
147  operator<<(float theArg);
148 
149  TPythonDump&
150  operator<<(const void* theArg);
151 
152  TPythonDump&
153  operator<<(const char* theArg);
154 
155  TPythonDump&
156  operator<<(const SMESH::ElementType& theArg);
157 
158  TPythonDump&
159  operator<<(const SMESH::GeometryType& theArg);
160 
161  TPythonDump&
162  operator<<(const SMESH::EntityType& theArg);
163 
164  TPythonDump&
165  operator<<(const SMESH::long_array& theArg);
166 
167  TPythonDump&
168  operator<<(const SMESH::smIdType_array& theArg);
169 
170  TPythonDump&
171  operator<<(const SMESH::double_array& theArg);
172 
173  TPythonDump&
174  operator<<(const SMESH::string_array& theArg);
175 
176  TPythonDump&
177  operator<<(const SMESH::nodes_array& theArg);
178 
179  TPythonDump&
180  operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
181 
182  TPythonDump&
183  operator<<(SMESH::SMESH_IDSource_ptr theArg);
184 
185  TPythonDump&
186  operator<<(SALOMEDS::SObject_ptr theArg);
187 
188  TPythonDump&
189  operator<<(CORBA::Object_ptr theArg);
190 
191  TPythonDump&
193 
194  TPythonDump&
196 
197  TPythonDump&
198  operator<<(SMESH::Filter_i* theArg);
199 
200  TPythonDump&
201  operator<<(SMESH::Functor_i* theArg);
202 
203  TPythonDump&
205 
206  TPythonDump&
207  operator<<(SMESH_Gen_i* theArg);
208 
209  TPythonDump&
211 
212  TPythonDump&
213  operator<<(const SMESH::AxisStruct & theAxis);
214 
215  TPythonDump&
216  operator<<(const SMESH::DirStruct & theDir);
217 
218  TPythonDump&
219  operator<<(const SMESH::PointStruct & P);
220 
221  TPythonDump&
222  operator<<(const TCollection_AsciiString & theArg);
223 
224  TPythonDump&
225  operator<<(const SMESH::ListOfGroups& theList);
226 
227  TPythonDump&
228  operator<<(const SMESH::ListOfGroups * theList);
229 
230  TPythonDump&
231  operator<<(const GEOM::ListOfGO& theList);
232 
233  TPythonDump&
234  operator<<(const GEOM::ListOfGBO& theList);
235 
236  TPythonDump&
237  operator<<(const SMESH::ListOfIDSources& theList);
238 
239  TPythonDump&
240  operator<<(const SMESH::submesh_array& theList);
241 
242  TPythonDump&
243  operator<<(const SMESH::ListOfHypothesis& theList);
244 
245  TPythonDump&
247 
248  TPythonDump&
249  operator<<(const std::string& theArg);
250 
251 
252  template<class TArray, class TStream>
253  static TStream& DumpArray(const TArray& theArray, TStream & theStream)
254  {
255  if ( theArray.length() == 0 )
256  {
257  theStream << "[]";
258  }
259  else
260  {
261  theStream << "[ ";
262  for (CORBA::ULong i = 1; i <= theArray.length(); i++) {
263  theStream << theArray[i-1];
264  if ( i < theArray.length() )
265  theStream << ", ";
266  }
267  theStream << " ]";
268  }
269  return theStream;
270  }
271 
272  static const char* SMESHGenName() { return "smeshgen"; }
273  static const char* MeshEditorName() { return "mesh_editor"; }
274  static const char* NotPublishedObjectName();
275 
282  static TCollection_AsciiString LongStringStart(const char* type);
288  static TCollection_AsciiString LongStringEnd();
300  static bool CutoutLongString( TCollection_AsciiString & theText,
301  int & theFrom,
302  TCollection_AsciiString & theLongString,
303  TCollection_AsciiString & theStringType);
304  };
305 }
306 
307 #endif
ostream & operator<<(ostream &OS, const SMDS_MeshElement *e)
Definition: SMDS_MeshElement.cxx:212
#define SMESH_I_EXPORT
Definition: SMESH.hxx:39
Definition: SMESH_Filter_i.hxx:1077
Definition: SMESH_Filter_i.hxx:1115
Definition: SMESH_Filter_i.hxx:996
Definition: SMESH_Filter_i.hxx:80
Definition: SMESH_Measurements_i.hxx:45
Utility helping in storing SMESH engine calls as python commands.
Definition: SMESH_PythonDump.hxx:121
int myVarsCounter
Definition: SMESH_PythonDump.hxx:124
static const char * SMESHGenName()
Definition: SMESH_PythonDump.hxx:272
static TStream & DumpArray(const TArray &theArray, TStream &theStream)
Definition: SMESH_PythonDump.hxx:253
static size_t myCounter
Definition: SMESH_PythonDump.hxx:123
static const char * MeshEditorName()
Definition: SMESH_PythonDump.hxx:273
std::ostringstream myStream
Definition: SMESH_PythonDump.hxx:122
Tool converting SMESH engine calls into commands defined in smeshBuilder.py.
Definition: SMESH_PythonDump.hxx:54
static const char * GenName()
Definition: SMESH_PythonDump.hxx:79
static const char * SmeshpyName()
Return the name of the python file wrapping IDL API.
Definition: SMESH_PythonDump.hxx:78
static void ConvertScript(std::list< TCollection_AsciiString > &theScriptLines, Resource_DataMapOfAsciiStringAsciiString &theEntry2AccessorMethod, Resource_DataMapOfAsciiStringAsciiString &theObjectNames, std::set< TCollection_AsciiString > &theRemovedObjIDs, const bool theHistoricalDump)
Convert a python script using commands of smeshBuilder.py.
Definition: SMESH_2smeshpy.cxx:484
Definition: SMESH_Gen_i.hxx:99
Definition: SMESH_MeshEditor_i.hxx:50
Definition: SMESH_ControlsDef.hxx:64
EntityType
Enumeration of entity type used in mesh info array, it should be synchronised with enum SMDSAbs_Entit...
Definition: SMESH_Mesh.idl:174
sequence< SMESH_subMesh > submesh_array
Definition: SMESH_Mesh.idl:332
sequence< SMESH_IDSource > ListOfIDSources
Definition: SMESH_Mesh.idl:40
sequence< smIdType > smIdType_array
Definition: SMESH_Mesh.idl:45
GeometryType
Enumeration for element geometry type, like SMDSAbs_GeometryType in SMDSAbs_ElementType....
Definition: SMESH_Mesh.idl:144
ElementType
Enumeration for element type, like in SMDS.
Definition: SMESH_Mesh.idl:128
sequence< double > double_array
Definition: SMESH_Mesh.idl:43
sequence< string > string_array
Definition: SMESH_Mesh.idl:46
sequence< SMESH_Hypothesis > ListOfHypothesis
Definition: SMESH_Mesh.idl:36
sequence< SMESH_GroupBase > ListOfGroups
Definition: SMESH_Mesh.idl:38
sequence< PointStruct > nodes_array
Definition: SMESH_Mesh.idl:97
sequence< long > long_array
Definition: SMESH_Mesh.idl:44
Definition: SMESH_Mesh.idl:101
Definition: SMESH_MeshEditor.idl:55
Definition: SMESH_Mesh.idl:99
Definition: SMESH_Mesh.idl:93
Object used to make TPythonDump know that its held value can be a variable.
Definition: SMESH_PythonDump.hxx:99
static char Quote()
Definition: SMESH_PythonDump.hxx:109
bool myIsList
Definition: SMESH_PythonDump.hxx:101
std::vector< std::string > myVals
Definition: SMESH_PythonDump.hxx:100
static const char * ObjPrefix()
Definition: SMESH_PythonDump.hxx:111