1 // Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SMESH_smesh.hxx
24 // Created : Fri Nov 18 12:05:18 2005
25 // Author : Edward AGAPOV (eap)
27 #ifndef SMESH_smesh_HeaderFile
28 #define SMESH_smesh_HeaderFile
30 #include <Standard_DefineHandle.hxx>
31 #include <Standard_Type.hxx>
32 #include <Standard_Transient.hxx>
33 #include <TCollection_AsciiString.hxx>
34 #include <TColStd_SequenceOfAsciiString.hxx>
35 #include <TColStd_SequenceOfInteger.hxx>
40 // ===========================================================================================
42 * This file was created in order to respond to requirement of bug PAL10494:
43 * SMESH python dump uses idl interface.
45 * The creation reason is that smesh.py commands defining hypotheses encapsulate
46 * several SMESH engine method calls. As well, the dependencies between smesh.py
47 * classes differ from ones between corresponding SMESH IDL interfaces.
49 * Everything here is for internal usage by SMESH_2smeshpy::ConvertScript()
50 * declared in SMESH_PythonDump.hxx
52 * See comments to _pyHypothesis class to know how to assure convertion of a new
55 // ===========================================================================================
57 class Resource_DataMapOfAsciiStringAsciiString;
59 // ===========================================================================================
60 // =====================
62 // =====================
63 // ===========================================================================================
73 DEFINE_STANDARD_HANDLE (_pyCommand ,Standard_Transient);
74 DEFINE_STANDARD_HANDLE (_pyObject ,Standard_Transient);
75 DEFINE_STANDARD_HANDLE (_pyGen ,_pyObject);
76 DEFINE_STANDARD_HANDLE (_pyMesh ,_pyObject);
77 DEFINE_STANDARD_HANDLE (_pySubMesh ,_pyObject);
78 DEFINE_STANDARD_HANDLE (_pyMeshEditor,_pyObject);
79 DEFINE_STANDARD_HANDLE (_pyHypothesis,_pyObject);
80 DEFINE_STANDARD_HANDLE (_pyAlgorithm ,_pyHypothesis);
82 typedef TCollection_AsciiString _pyID;
84 // ===========================================================
86 * \brief Class operating on a command string looking like
87 * ResultValue = Object.Method( Arg1, Arg2,...)
89 // ===========================================================
91 class _pyCommand: public Standard_Transient
93 int myOrderNb; //!< position within the script
94 TCollection_AsciiString myString; //!< command text
95 TCollection_AsciiString myRes, myObj, myMeth; //!< found parts of command
96 TColStd_SequenceOfAsciiString myArgs; //!< found arguments
97 TColStd_SequenceOfInteger myBegPos; //!< where myRes, myObj, ... begin
98 std::list< Handle(_pyCommand) > myDependentCmds; //!< commands that sould follow me in the script
100 enum { UNKNOWN=-1, EMPTY=0, RESULT_IND, OBJECT_IND, METHOD_IND, ARG1_IND };
101 int GetBegPos( int thePartIndex );
102 void SetBegPos( int thePartIndex, int thePosition );
103 void SetPart( int thePartIndex, const TCollection_AsciiString& theNewPart,
104 TCollection_AsciiString& theOldPart);
105 void FindAllArgs() { GetArg(1); }
109 _pyCommand( const TCollection_AsciiString& theString, int theNb )
110 : myString( theString ), myOrderNb( theNb ) {};
111 TCollection_AsciiString & GetString() { return myString; }
112 int GetOrderNb() const { return myOrderNb; }
113 void SetOrderNb( int theNb ) { myOrderNb = theNb; }
114 int Length() { return myString.Length(); }
115 void Clear() { myString.Clear(); myBegPos.Clear(); myArgs.Clear(); }
116 bool IsEmpty() const { return myString.IsEmpty(); }
117 TCollection_AsciiString GetIndentation();
118 const TCollection_AsciiString & GetResultValue();
119 const int GetNbResultValues();
120 const TCollection_AsciiString & GetResultValue(int res);
121 const TCollection_AsciiString & GetObject();
122 const TCollection_AsciiString & GetMethod();
123 const TCollection_AsciiString & GetArg( int index );
124 int GetNbArgs() { FindAllArgs(); return myArgs.Length(); }
125 //Handle(TColStd_HSequenceOfAsciiString) GetArgs();
126 void SetResultValue( const TCollection_AsciiString& theResult )
127 { GetResultValue(); SetPart( RESULT_IND, theResult, myRes ); }
128 void SetObject(const TCollection_AsciiString& theObject)
129 { GetObject(); SetPart( OBJECT_IND, theObject, myObj ); }
130 void SetMethod(const TCollection_AsciiString& theMethod)
131 { GetMethod(); SetPart( METHOD_IND, theMethod, myMeth ); }
132 void SetArg( int index, const TCollection_AsciiString& theArg);
134 static bool SkipSpaces( const TCollection_AsciiString & theSring, int & thePos );
135 static TCollection_AsciiString GetWord( const TCollection_AsciiString & theSring,
136 int & theStartPos, const bool theForward,
137 const bool dotIsWord = false);
138 void AddDependantCmd( Handle(_pyCommand) cmd, bool prepend = false)
139 { if (prepend) myDependentCmds.push_front( cmd ); else myDependentCmds.push_back( cmd ); }
140 bool SetDependentCmdsAfter() const;
142 bool AddAccessorMethod( _pyID theObjectID, const char* theAcsMethod );
144 DEFINE_STANDARD_RTTI (_pyCommand)
147 // -------------------------------------------------------------------------------------
149 * \brief Root of all objects. It counts calls of Process()
151 // -------------------------------------------------------------------------------------
153 class _pyObject: public Standard_Transient
155 Handle(_pyCommand) myCreationCmd;
158 _pyObject(const Handle(_pyCommand)& theCreationCmd)
159 : myCreationCmd(theCreationCmd), myNbCalls(0) {}
160 const _pyID& GetID() { return myCreationCmd->GetResultValue(); }
161 static _pyID FatherID(const _pyID & childID);
162 const Handle(_pyCommand)& GetCreationCmd() { return myCreationCmd; }
163 int GetNbCalls() const { return myNbCalls; }
164 void SetCreationCmd( Handle(_pyCommand) cmd ) { myCreationCmd = cmd; }
165 int GetCommandNb() { return myCreationCmd->GetOrderNb(); }
166 virtual void Process(const Handle(_pyCommand) & theCommand) { myNbCalls++; }
167 virtual void Flush() = 0;
168 virtual const char* AccessorMethod() const;
170 DEFINE_STANDARD_RTTI (_pyObject)
173 // -------------------------------------------------------------------------------------
175 * \brief Class corresponding to SMESH_Gen. It holds info on existing
176 * meshes and hypotheses
178 // -------------------------------------------------------------------------------------
179 class _pyGen: public _pyObject
182 _pyGen(Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
183 Resource_DataMapOfAsciiStringAsciiString& theObjectNames);
184 Handle(_pyCommand) AddCommand( const TCollection_AsciiString& theCommand );
185 void Process( const Handle(_pyCommand)& theCommand );
187 Handle(_pyHypothesis) FindHyp( const _pyID& theHypID );
188 Handle(_pyHypothesis) FindAlgo( const _pyID& theGeom, const _pyID& theMesh,
189 const Handle(_pyHypothesis)& theHypothesis);
190 Handle(_pySubMesh) FindSubMesh( const _pyID& theSubMeshID );
191 void ExchangeCommands( Handle(_pyCommand) theCmd1, Handle(_pyCommand) theCmd2 );
192 void SetCommandAfter( Handle(_pyCommand) theCmd, Handle(_pyCommand) theAfterCmd );
193 void SetCommandBefore( Handle(_pyCommand) theCmd, Handle(_pyCommand) theBeforeCmd );
194 Handle(_pyCommand)& GetLastCommand();
195 std::list< Handle(_pyCommand) >& GetCommands() { return myCommands; }
196 void SetAccessorMethod(const _pyID& theID, const char* theMethod );
197 bool AddMeshAccessorMethod( Handle(_pyCommand) theCmd ) const;
198 bool AddAlgoAccessorMethod( Handle(_pyCommand) theCmd ) const;
199 const char* AccessorMethod() const;
200 _pyID GenerateNewID( const _pyID& theID );
201 void AddObject( Handle(_pyObject)& theObj );
202 Handle(_pyObject) FindObject( const _pyID& theObjID ) const;
205 void setNeighbourCommand( Handle(_pyCommand)& theCmd,
206 Handle(_pyCommand)& theOtherCmd,
207 const bool theIsAfter );
210 std::map< _pyID, Handle(_pyMesh) > myMeshes;
211 std::map< _pyID, Handle(_pyMeshEditor) > myMeshEditors;
212 std::map< _pyID, Handle(_pyObject) > myObjects;
213 std::list< Handle(_pyHypothesis) > myHypos;
214 std::list< Handle(_pyCommand) > myCommands;
216 Resource_DataMapOfAsciiStringAsciiString& myID2AccessorMethod;
217 Resource_DataMapOfAsciiStringAsciiString& myObjectNames;
218 Handle(_pyCommand) myLastCommand;
221 DEFINE_STANDARD_RTTI (_pyGen)
224 // -------------------------------------------------------------------------------------
226 * \brief Contains commands concerning mesh substructures
228 // -------------------------------------------------------------------------------------
229 #define _pyMesh_ACCESS_METHOD "GetMesh()"
230 class _pyMesh: public _pyObject
232 std::list< Handle(_pyHypothesis) > myHypos;
233 std::list< Handle(_pyCommand) > myAddHypCmds;
234 std::list< Handle(_pySubMesh) > mySubmeshes;
237 _pyMesh(const Handle(_pyCommand) creationCmd);
238 _pyMesh(const Handle(_pyCommand) theCreationCmd, const TCollection_AsciiString & id);
239 const _pyID& GetGeom() { return GetCreationCmd()->GetArg(1); }
240 void Process( const Handle(_pyCommand)& theCommand);
242 const char* AccessorMethod() const { return _pyMesh_ACCESS_METHOD; }
244 static bool NeedMeshAccess( const Handle(_pyCommand)& theCommand );
245 static void AddMeshAccess( const Handle(_pyCommand)& theCommand )
246 { theCommand->SetObject( theCommand->GetObject() + "." _pyMesh_ACCESS_METHOD ); }
248 DEFINE_STANDARD_RTTI (_pyMesh)
250 #undef _pyMesh_ACCESS_METHOD
252 // -------------------------------------------------------------------------------------
254 * \brief MeshEditor convert its commands to ones of mesh
256 // -------------------------------------------------------------------------------------
257 class _pyMeshEditor: public _pyObject
260 TCollection_AsciiString myCreationCmdStr;
262 _pyMeshEditor(const Handle(_pyCommand)& theCreationCmd);
263 void Process( const Handle(_pyCommand)& theCommand);
264 virtual void Flush() {}
266 DEFINE_STANDARD_RTTI (_pyMesh)
269 // -------------------------------------------------------------------------------------
271 * \brief Root class for hypothesis
273 * HOWTO assure convertion of a new type of hypothesis
274 * In _pyHypothesis::NewHypothesis():
275 * 1. add a case for the name of the new hypothesis
276 * 2. use SetConvMethodAndType() to set
277 * . for algo: algorithm name and method of Mesh creating the algo
278 * . for hypo: name of the algorithm and method creating the hypothesis
279 * 3. append to myArgMethods interface methods setting param values in the
280 * order they are used when creation method is called. If arguments of
281 * the creation method can't be easily got from calls of hypothesis methods, you are
282 * to derive a specific class from _pyHypothesis that would redefine Process(),
283 * see _pyComplexParamHypo for example
285 // -------------------------------------------------------------------------------------
286 class _pyHypothesis: public _pyObject
289 bool myIsAlgo, myIsWrapped;
290 _pyID myGeom, myMesh;
291 // a hypothesis can be used and created by different algos by different methods
292 std::map<TCollection_AsciiString, TCollection_AsciiString > myType2CreationMethod;
293 //TCollection_AsciiString myCreationMethod, myType;
294 TColStd_SequenceOfAsciiString myArgs; // creation arguments
295 TColStd_SequenceOfAsciiString myArgMethods; // hypo methods setting myArgs
296 TColStd_SequenceOfInteger myNbArgsByMethod; // nb args set by each method
297 std::list<Handle(_pyCommand)> myArgCommands;
298 std::list<Handle(_pyCommand)> myUnknownCommands;
300 _pyHypothesis(const Handle(_pyCommand)& theCreationCmd);
301 void SetConvMethodAndType(const char* creationMethod, const char* type)
302 { myType2CreationMethod[ (char*)type ] = (char*)creationMethod; }
303 void AddArgMethod(const char* method, const int nbArgs = 1)
304 { myArgMethods.Append( (char*)method ); myNbArgsByMethod.Append( nbArgs ); }
305 const TColStd_SequenceOfAsciiString& GetArgs() const { return myArgs; }
306 const std::list<Handle(_pyCommand)>& GetArgCommands() const { return myArgCommands; }
307 void ClearAllCommands();
308 virtual bool IsAlgo() const { return myIsAlgo; }
309 bool IsValid() const { return !myType2CreationMethod.empty(); }
310 bool IsWrapped() const { return myIsWrapped; }
311 const _pyID & GetGeom() const { return myGeom; }
312 void SetMesh( const _pyID& theMeshId) { if ( myMesh.IsEmpty() ) myMesh = theMeshId; }
313 const _pyID & GetMesh() const { return myMesh; }
314 const TCollection_AsciiString& GetAlgoType() const
315 { return myType2CreationMethod.begin()->first; }
316 const TCollection_AsciiString& GetAlgoCreationMethod() const
317 { return myType2CreationMethod.begin()->second; }
318 bool CanBeCreatedBy(const TCollection_AsciiString& algoType ) const
319 { return myType2CreationMethod.find( algoType ) != myType2CreationMethod.end(); }
320 const TCollection_AsciiString& GetCreationMethod(const TCollection_AsciiString& algoType) const
321 { return myType2CreationMethod.find( algoType )->second; }
322 virtual bool IsWrappable(const _pyID& theMesh) { return !myIsWrapped && myMesh == theMesh; }
323 virtual bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
324 const _pyID& theMesh);
325 static Handle(_pyHypothesis) NewHypothesis( const Handle(_pyCommand)& theCreationCmd);
326 void Process( const Handle(_pyCommand)& theCommand);
328 virtual void Assign( const Handle(_pyHypothesis)& theOther,
329 const _pyID& theMesh );
331 DEFINE_STANDARD_RTTI (_pyHypothesis)
334 // -------------------------------------------------------------------------------------
336 * \brief Class representing smesh.Mesh_Algorithm
338 // -------------------------------------------------------------------------------------
339 class _pyAlgorithm: public _pyHypothesis
342 _pyAlgorithm(const Handle(_pyCommand)& theCreationCmd);
343 virtual bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
344 const _pyID& theMesh);
345 const char* AccessorMethod() const { return "GetAlgorithm()"; }
346 virtual bool IsWrappable(const _pyID& theMesh) { return !myIsWrapped; }
348 DEFINE_STANDARD_RTTI (_pyAlgorithm)
351 // -------------------------------------------------------------------------------------
353 * \brief Class for hypotheses having several parameters modified by one method
355 // -------------------------------------------------------------------------------------
356 class _pyComplexParamHypo: public _pyHypothesis
359 _pyComplexParamHypo(const Handle(_pyCommand)& theCreationCmd): _pyHypothesis(theCreationCmd) {}
360 void Process( const Handle(_pyCommand)& theCommand);
363 DEFINE_STANDARD_RTTI (_pyComplexParamHypo)
365 DEFINE_STANDARD_HANDLE (_pyComplexParamHypo, _pyHypothesis);
367 // -------------------------------------------------------------------------------------
369 * \brief Class for LayerDistribution hypothesis conversion
371 // -------------------------------------------------------------------------------------
372 class _pyLayerDistributionHypo: public _pyHypothesis
374 Handle(_pyHypothesis) my1dHyp;
375 TCollection_AsciiString myAlgoMethod;
377 _pyLayerDistributionHypo(const Handle(_pyCommand)& theCreationCmd, const char* algoMethod):
378 _pyHypothesis(theCreationCmd), myAlgoMethod((char*)algoMethod) {}
379 void Process( const Handle(_pyCommand)& theCommand);
381 bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
382 const _pyID& theMesh);
384 DEFINE_STANDARD_RTTI (_pyLayerDistributionHypo)
386 DEFINE_STANDARD_HANDLE (_pyLayerDistributionHypo, _pyHypothesis);
388 // -------------------------------------------------------------------------------------
390 * \brief Class representing NumberOfSegments hypothesis
392 // -------------------------------------------------------------------------------------
393 class _pyNumberOfSegmentsHyp: public _pyHypothesis
396 _pyNumberOfSegmentsHyp(const Handle(_pyCommand)& theCrCmd): _pyHypothesis(theCrCmd) {}
397 virtual bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
398 const _pyID& theMesh);
401 DEFINE_STANDARD_RTTI (_pyNumberOfSegmentsHyp)
403 DEFINE_STANDARD_HANDLE (_pyNumberOfSegmentsHyp, _pyHypothesis);
405 // -------------------------------------------------------------------------------------
407 * \brief Class representing SegmentLengthAroundVertex hypothesis
409 // -------------------------------------------------------------------------------------
410 class _pySegmentLengthAroundVertexHyp: public _pyHypothesis
413 _pySegmentLengthAroundVertexHyp(const Handle(_pyCommand)& theCrCmd): _pyHypothesis(theCrCmd) {}
414 virtual bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
415 const _pyID& theMesh);
416 DEFINE_STANDARD_RTTI (_pySegmentLengthAroundVertexHyp)
418 DEFINE_STANDARD_HANDLE (_pySegmentLengthAroundVertexHyp, _pyHypothesis);
420 // -------------------------------------------------------------------------------------
422 * \brief SelfEraser erases creation command if no more it's commands invoked
424 // -------------------------------------------------------------------------------------
425 class _pySelfEraser: public _pyObject
428 _pySelfEraser(const Handle(_pyCommand)& theCreationCmd):_pyObject(theCreationCmd) {}
429 virtual void Flush();
431 DEFINE_STANDARD_RTTI (_pySelfEraser)
433 DEFINE_STANDARD_HANDLE (_pySelfEraser, _pyObject);
435 // -------------------------------------------------------------------------------------
437 * \brief SubMesh creation can be moved to the end of engine commands
439 // -------------------------------------------------------------------------------------
440 class _pySubMesh: public _pyObject
443 _pySubMesh(const Handle(_pyCommand)& theCreationCmd):_pyObject(theCreationCmd) {}
444 void Process( const Handle(_pyCommand)& theCommand);
445 virtual void Flush();
446 void SetCreator( const Handle(_pyObject)& theCreator ) { myCreator = theCreator; }
448 DEFINE_STANDARD_RTTI (_pySubMesh)
450 Handle(_pyObject) myCreator;
452 // -------------------------------------------------------------------------------------
454 * \brief To convert creation of a group by filter
456 // -------------------------------------------------------------------------------------
457 class _pyGroup: public _pyObject
460 _pyGroup(const Handle(_pyCommand)& theCreationCmd):_pyObject(theCreationCmd) {}
461 void Process( const Handle(_pyCommand)& theCommand);
462 virtual void Flush() {}
464 DEFINE_STANDARD_RTTI (_pyGroup)
466 DEFINE_STANDARD_HANDLE (_pyGroup, _pyObject);
468 // -------------------------------------------------------------------------------------
470 * \brief A filter sets a human readable name to self
472 // -------------------------------------------------------------------------------------
473 class _pyFilter: public _pyObject
477 _pyFilter(const Handle(_pyCommand)& theCreationCmd, const _pyID& newID="");
478 void Process( const Handle(_pyCommand)& theCommand);
479 virtual void Flush();
480 const _pyID& GetNewID() const { return myNewID; }
482 DEFINE_STANDARD_RTTI (_pyFilter)
484 DEFINE_STANDARD_HANDLE (_pyFilter, _pyObject);