Salome HOME
Implementation notebook in the SMESH module.
[modules/smesh.git] / src / SMESH_I / SMESH_NoteBook.cxx
1 // Copyright (C) 2008  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
3 //
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License.
8 //
9 // This library is distributed in the hope that it will be useful
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 // Lesser General Public License for more details.
13 //
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17 //
18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 //
20 // File      : SMESH_NoteBook.cxx
21 // Author    : Roman NIKOLAEV
22
23 #include "SMESH_2smeshpy.hxx"
24 #include "SMESH_NoteBook.hxx"
25 #include "SMESH_Gen_i.hxx"
26 #include "SMESH_PythonDump.hxx"
27
28 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
29 #include <TColStd_SequenceOfAsciiString.hxx>
30 #include <TColStd_HSequenceOfInteger.hxx>
31
32 #include <vector>
33 #include <string>
34
35 #ifdef _DEBUG_
36 static int MYDEBUG = 1;
37 #else
38 static int MYDEBUG = 1;
39 #endif
40
41 using namespace std;
42
43
44
45 //================================================================================
46 /*!
47  * \brief Constructor
48  */
49 //================================================================================
50 ObjectStates::ObjectStates(TCollection_AsciiString theType)
51 {
52   _type = theType;
53   _dumpstate = 0;
54 }
55
56 //================================================================================
57 /*!
58  * \brief Destructor
59  */
60 //================================================================================
61 ObjectStates::~ObjectStates()
62 {
63 }
64
65 //================================================================================
66 /*!
67  * \brief Add new object state 
68  * \param theState - Object state (vector of notebook variable)
69  */
70 //================================================================================
71 void ObjectStates::AddState(const TState &theState)
72 {
73   _states.push_back(theState);
74 }
75
76 //================================================================================
77 /*!
78  * \brief Return current object state
79  * \\retval state - Object state (vector of notebook variable)
80  */
81 //================================================================================
82 TState ObjectStates::GetCurrectState() const
83 {
84   if(_states.size() > _dumpstate)
85     return _states[_dumpstate];
86   TState empty;
87   return empty;
88 }
89
90
91 //================================================================================
92 /*!
93  *
94  */
95 //================================================================================
96 TAllStates ObjectStates::GetAllStates() const
97 {
98   return _states;
99 }
100
101 //================================================================================
102 /*!
103  *
104  */
105 //================================================================================
106 void ObjectStates::IncrementState()
107 {
108   _dumpstate++;
109 }
110
111 //================================================================================
112 /*!
113  *
114  */
115 //================================================================================
116 TCollection_AsciiString ObjectStates::GetObjectType() const{
117   return _type;
118 }
119
120
121 //================================================================================
122 /*!
123  * \brief Constructor
124  */
125 //================================================================================
126 LayerDistributionStates::LayerDistributionStates():
127   ObjectStates("LayerDistribution")
128 {
129 }
130 //================================================================================
131 /*!
132  * \brief Destructor
133  */
134 //================================================================================
135 LayerDistributionStates::~LayerDistributionStates()
136 {
137 }
138
139
140 //================================================================================
141 /*!
142  * \brief AddDistribution
143  */
144 //================================================================================
145 void LayerDistributionStates::AddDistribution(const TCollection_AsciiString& theDistribution)
146 {
147   _distributions.insert(pair<TCollection_AsciiString,TCollection_AsciiString>(theDistribution,""));
148 }
149
150 //================================================================================
151 /*!
152  * \brief HasDistribution
153  */
154 //================================================================================
155 bool LayerDistributionStates::HasDistribution(const TCollection_AsciiString& theDistribution) const
156 {
157   return _distributions.find(theDistribution) != _distributions.end();
158 }
159
160 //================================================================================
161 /*!
162  * \brief SetDistributionType
163  */
164 //================================================================================
165 bool LayerDistributionStates::SetDistributionType(const TCollection_AsciiString& theDistribution,
166                                                   const TCollection_AsciiString& theType)
167 {
168   TDistributionMap::iterator it = _distributions.find(theDistribution);
169   if(it == _distributions.end())
170     return false;
171   (*it).second = theType;
172   return true;
173 }
174
175 //================================================================================
176 /*!
177  * \brief GetDistributionType
178  */
179 //================================================================================
180 TCollection_AsciiString LayerDistributionStates::
181 GetDistributionType(const TCollection_AsciiString& theDistribution) const
182 {
183   TDistributionMap::const_iterator it = _distributions.find(theDistribution);
184   return (it == _distributions.end()) ? TCollection_AsciiString() : (*it).second;
185 }
186
187 //================================================================================
188 /*!
189  * \brief Constructor
190  */
191 //================================================================================
192 SMESH_NoteBook::SMESH_NoteBook()
193 {
194   InitObjectMap();
195 }
196
197 //================================================================================
198 /*!
199  * \brief Destructor
200  */
201 //================================================================================
202 SMESH_NoteBook::~SMESH_NoteBook()
203 {
204   TVariablesMap::const_iterator it = _objectMap.begin();
205   for(;it!=_objectMap.end();it++) {
206     if((*it).second)
207       delete (*it).second;
208   }
209 }
210
211 //================================================================================
212 /*!
213  * \brief Replace parameters of the functions on the Salome NoteBook Variables
214  * \param theString - Input string
215  * \retval TCollection_AsciiString - Convertion result
216  */
217 //================================================================================
218 void SMESH_NoteBook::ReplaceVariables()
219 {
220   for(int i=0;i<_commands.size();i++) {
221     Handle(_pyCommand) aCmd = _commands[i];
222     TCollection_AsciiString aMethod = aCmd->GetMethod();
223     TCollection_AsciiString aObject = aCmd->GetObject();
224     TCollection_AsciiString aResultValue = aCmd->GetResultValue();
225     if(MYDEBUG) {
226       cout<<"Command before : "<< aCmd->GetString()<<endl;
227       cout<<"Method : "<< aMethod<<endl;
228       cout<<"Object : "<< aObject<<endl;
229       cout<<"Result : "<< aResultValue<<endl;
230     }
231     
232     // check if method modifies the object itself
233     TVariablesMap::const_iterator it = _objectMap.find(aObject);
234     if(it == _objectMap.end()) // check if method returns a new object
235       it = _objectMap.find(aResultValue);
236     
237     if(it == _objectMap.end()) { // check if method modifies a mesh using mesh editor
238       TMeshEditorMap::const_iterator meIt = myMeshEditors.find(aObject);
239       if(meIt != myMeshEditors.end()) {
240         TCollection_AsciiString aMesh = (*meIt).second;
241         it = _objectMap.find(aMesh);
242       }
243     }
244     
245     if(it != _objectMap.end() && !aMethod.IsEmpty()) {
246       ObjectStates *aStates = (*it).second;
247       // Case for LocalLength hypothesis
248       if(aStates->GetObjectType().IsEqual("LocalLength") && aStates->GetCurrectState().size() >= 2) {
249         if(aMethod.IsEqual("SetLength")) {
250           if(!aStates->GetCurrectState().at(0).IsEmpty() )
251             aCmd->SetArg(1,aStates->GetCurrectState().at(0));
252           aStates->IncrementState();
253         }
254         else if(aMethod.IsEqual("SetPrecision")) {
255           if(!aStates->GetCurrectState().at(1).IsEmpty() )
256             aCmd->SetArg(1,aStates->GetCurrectState().at(1));
257           aStates->IncrementState();
258         }
259       }
260       
261       // Case for SegmentLengthAroundVertex hypothesis
262       else if(aStates->GetObjectType().IsEqual("SegmentLengthAroundVertex")
263               && aStates->GetCurrectState().size() >= 1) {
264         if(aMethod == "SetLength") {
265           if(!aStates->GetCurrectState().at(0).IsEmpty() )
266             aCmd->SetArg(1,aStates->GetCurrectState().at(0));
267           aStates->IncrementState();
268         }
269       }
270
271       // Case for Arithmetic1D and StartEndLength hypothesis
272       else if(aStates->GetObjectType().IsEqual("Arithmetic1D") || 
273               aStates->GetObjectType().IsEqual("StartEndLength")) {
274         if(aMethod == "SetLength" &&
275            aStates->GetCurrectState().size() >= 2) {
276           if(aCmd->GetArg(2) == "1" && !aStates->GetCurrectState().at(0).IsEmpty())
277             aCmd->SetArg(1,aStates->GetCurrectState().at(0));
278           else if(!aStates->GetCurrectState().at(1).IsEmpty())
279             aCmd->SetArg(1,aStates->GetCurrectState().at(1));
280           aStates->IncrementState();
281         }
282       }
283       
284       //Case for Deflection1D hypothesis
285       else if(aStates->GetObjectType().IsEqual("Deflection1D")){
286         if(aMethod == "SetDeflection" && aStates->GetCurrectState().size() >= 1) {
287           if(!aStates->GetCurrectState().at(0).IsEmpty() )
288             aCmd->SetArg(1,aStates->GetCurrectState().at(0));
289           aStates->IncrementState();
290         }
291       }
292       
293       // Case for LayerDistribution hypothesis (not finished yet)
294       else if(aStates->GetObjectType() == "LayerDistribution") {
295         if(aMethod == "SetLayerDistribution"){
296           LayerDistributionStates* aLDStates = (LayerDistributionStates*)(aStates);
297           aLDStates->AddDistribution(aCmd->GetArg(1));
298         }
299       }
300       
301       // Case for MaxElementArea hypothesis
302       else if(aStates->GetObjectType().IsEqual("MaxElementArea")){
303         if(aMethod == "SetMaxElementArea" && aStates->GetCurrectState().size() >= 1) {
304           if(!aStates->GetCurrectState().at(0).IsEmpty() )
305             aCmd->SetArg(1,aStates->GetCurrectState().at(0));
306           aStates->IncrementState();
307         }
308       }
309
310       // Case for NumberOfLayers hypothesis
311       else if(aStates->GetObjectType().IsEqual("NumberOfLayers")){
312         if(aMethod == "SetNumberOfLayers" && aStates->GetCurrectState().size() >= 1) {
313           if(!aStates->GetCurrectState().at(0).IsEmpty() )
314             aCmd->SetArg(1,aStates->GetCurrectState().at(0));
315           aStates->IncrementState();
316         }
317       }
318
319       // Case for NumberOfSegments hypothesis
320       else if(aStates->GetObjectType().IsEqual("NumberOfSegments")){
321         if(aMethod == "SetNumberOfSegments" && aStates->GetCurrectState().size() >= 1) {
322           if(!aStates->GetCurrectState().at(0).IsEmpty() )
323             aCmd->SetArg(1,aStates->GetCurrectState().at(0));
324           if(aStates->GetCurrectState().size()==1)
325             aStates->IncrementState();
326         }
327         else if (aMethod == "SetScaleFactor" && aStates->GetCurrectState().size() >= 2) {
328           if(!aStates->GetCurrectState().at(1).IsEmpty() )
329             aCmd->SetArg(1,aStates->GetCurrectState().at(1));
330           aStates->IncrementState();
331         }
332       }
333       
334       else if(aStates->GetObjectType().IsEqual("Mesh")) {
335         TState aCurrentState = aStates->GetCurrectState();
336         int aCurrentStateSize = aCurrentState.size();
337         if(aMethod.IsEqual("Translate") ||
338            aMethod.IsEqual("TranslateMakeGroups") ||
339            aMethod.IsEqual("TranslateMakeMesh")) {
340           bool isVariableFound = false;
341           int anArgIndex = 0;
342           for(int i = 1, n = aCmd->GetNbArgs(); i <= n; i++) {
343             if(aCmd->GetArg(i).IsEqual("SMESH.PointStruct")) {
344               anArgIndex = i+1;
345               break;
346             }
347           }
348           if(anArgIndex > 0) {
349             if(aCurrentStateSize == 3) { // translation by dx, dy, dz
350               for(int j = 0; j < aCurrentStateSize; j++) {
351                 if(!aCurrentState.at(j).IsEmpty()) {
352                   isVariableFound = true;
353                   aCmd->SetArg(anArgIndex+j, aCurrentState.at(j));
354                 }
355               }
356             }
357             else if(aCurrentStateSize == 6) { // translation by x1, x2, y1, y2, z1, z2
358               // TODO
359             }
360           }
361           if(isVariableFound) {
362             aCmd->SetArg(anArgIndex - 1, TCollection_AsciiString(SMESH_2smeshpy::SmeshpyName())+".PointStructStr");
363             aCmd->SetArg(anArgIndex - 2, TCollection_AsciiString(SMESH_2smeshpy::SmeshpyName())+".DirStructStr");
364           }
365           aStates->IncrementState();
366         }
367         else if(aMethod.IsEqual("Rotate") ||
368                 aMethod.IsEqual("RotateMakeGroups") ||
369                 aMethod.IsEqual("RotateMakeMesh") ||
370                 aMethod.IsEqual("Mirror") ||
371                 aMethod.IsEqual("MirrorMakeGroups") ||
372                 aMethod.IsEqual("MirrorMakeMesh")) {
373           bool isSubstitute = false;
374           int anArgIndex = 0;
375           for(int i = 1, n = aCmd->GetNbArgs(); i <= n; i++) {
376             if(aCmd->GetArg(i).IsEqual("SMESH.AxisStruct")) {
377               anArgIndex = i+1;
378               break;
379             }
380           }
381           if(anArgIndex > 0) {
382             for(int j = 0; j < aCurrentStateSize; j++) {
383               if(!aCurrentState.at(j).IsEmpty()) {
384                 if(j < 6) // from 0 to 5 - axis struct, 6 - angle
385                   isSubstitute = true;
386                 aCmd->SetArg(anArgIndex+j, aCurrentState.at(j));
387               }
388             }
389           }
390           if(isSubstitute)
391             aCmd->SetArg(anArgIndex - 1, TCollection_AsciiString(SMESH_2smeshpy::SmeshpyName())+".AxisStructStr");
392           aStates->IncrementState();
393         }
394         else if(aMethod.IsEqual("AddNode") ||
395                 aMethod.IsEqual("MoveClosestNodeToPoint")) {
396           for(int j = 0; j < aCurrentStateSize; j++) {
397             if(!aCurrentState.at(j).IsEmpty())
398               aCmd->SetArg(j+1, aCurrentState.at(j));
399           }
400           aStates->IncrementState();
401         }
402         else if(aMethod.IsEqual("MoveNode")) {
403           for(int j = 0; j < aCurrentStateSize; j++) {
404             if(!aCurrentState.at(j).IsEmpty())
405               aCmd->SetArg(j+2, aCurrentState.at(j));
406           }
407           aStates->IncrementState();
408         }
409         else if(aMethod.IsEqual("ExtrusionSweep") ||
410                 aMethod.IsEqual("ExtrusionSweepMakeGroups")) {
411           bool isSubstitute = false;
412           int anArgIndex = 0;
413           for(int i = 1, n = aCmd->GetNbArgs(); i <= n; i++) {
414             if(aCmd->GetArg(i).IsEqual("SMESH.PointStruct")) {
415               anArgIndex = i+1;
416               break;
417             }
418           }
419           if(anArgIndex > 0) {
420             for(int j = 0; j < aCurrentStateSize; j++) {
421               if(!aCurrentState.at(j).IsEmpty()) {
422                 if(j < 3) // from 0 to 2 - dir struct, 3 - number of steps
423                   isSubstitute = true;
424                 aCmd->SetArg(anArgIndex+j, aCurrentState.at(j));
425               }
426             }
427           }
428           if(isSubstitute) {
429             aCmd->SetArg(anArgIndex - 1, TCollection_AsciiString(SMESH_2smeshpy::SmeshpyName())+".PointStructStr");
430             aCmd->SetArg(anArgIndex - 2, TCollection_AsciiString(SMESH_2smeshpy::SmeshpyName())+".DirStructStr");
431           }
432           aStates->IncrementState();
433         }
434         else if(aMethod.IsEqual("TriToQuad") ||
435                 aMethod.IsEqual("Concatenate") ||
436                 aMethod.IsEqual("ConcatenateWithGroups")) {
437           if(aCurrentStateSize && !aCurrentState.at(0).IsEmpty())
438             aCmd->SetArg(aCmd->GetNbArgs(), aCurrentState.at(0));
439           aStates->IncrementState();
440         }
441         else if(aMethod.IsEqual("Smooth") ||
442                 aMethod.IsEqual("SmoothParametric")) {
443           int anArgIndex = aCmd->GetNbArgs() - 2;
444           for(int j = 0; j < aCurrentStateSize; j++) {
445             if(!aCurrentState.at(j).IsEmpty())
446               aCmd->SetArg(anArgIndex+j, aCurrentState.at(j));
447           }
448           aStates->IncrementState();
449         }
450       }
451     }
452     if(MYDEBUG) {
453       cout<<"Command after: "<< aCmd->GetString()<<endl;
454     }
455   }
456   //  ProcessLayerDistribution();
457 }
458 //================================================================================
459 /*!
460  * \brief Private method
461  */
462 //================================================================================
463 void SMESH_NoteBook::InitObjectMap()
464 {
465   SMESH_Gen_i *aGen = SMESH_Gen_i::GetSMESHGen();
466   if(!aGen)
467     return;
468   
469   SALOMEDS::Study_ptr aStudy = aGen->GetCurrentStudy();
470   if(aStudy->_is_nil())
471     return;
472   
473   SALOMEDS::SObject_var aSO = aStudy->FindComponent(aGen->ComponentDataType());
474   if(CORBA::is_nil(aSO))
475     return;
476   
477   SALOMEDS::ChildIterator_var Itr = aStudy->NewChildIterator(aSO);
478   char* aParameters;
479   for(Itr->InitEx(true); Itr->More(); Itr->Next()) {
480     SALOMEDS::SObject_var aSObject = Itr->Value();
481     SALOMEDS::GenericAttribute_var anAttr;
482     if ( aSObject->FindAttribute(anAttr, "AttributeString")) {
483       aParameters = SALOMEDS::AttributeString::_narrow(anAttr)->Value();
484       SALOMEDS::ListOfListOfStrings_var aSections = aStudy->ParseVariables(aParameters);
485       if(MYDEBUG) {
486         cout<<"Entry : "<< aSObject->GetID()<<endl;
487         cout<<"aParameters : "<<aParameters<<endl;
488       }      
489       TCollection_AsciiString anObjType;
490       CORBA::Object_var anObject = SMESH_Gen_i::SObjectToObject(aSObject);
491       SMESH::SMESH_Hypothesis_var aHyp = SMESH::SMESH_Hypothesis::_narrow(anObject);
492       if(!aHyp->_is_nil()) {
493         anObjType = TCollection_AsciiString(aHyp->GetName());
494       }
495       else if(SMESH::SMESH_Mesh_var aMesh = SMESH::SMESH_Mesh::_narrow(anObject)) {
496         anObjType = TCollection_AsciiString("Mesh");
497       }
498       if(MYDEBUG)
499         cout<<"The object Type : "<<anObjType<<endl;
500       ObjectStates *aState = NULL;
501       if(anObjType == "LayerDistribution")
502         aState = new LayerDistributionStates();
503       else
504         aState = new  ObjectStates(anObjType);
505       
506       for(int i = 0; i < aSections->length(); i++) {
507         TState aVars;
508         SALOMEDS::ListOfStrings aListOfVars = aSections[i];
509         for(int j = 0;j<aListOfVars.length();j++) {
510           TCollection_AsciiString aVar(aListOfVars[j].in());
511           if(!aVar.IsEmpty() && aStudy->IsVariable(aVar.ToCString())) {
512             aVar.InsertBefore(1,"\"");
513             aVar.InsertAfter(aVar.Length(),"\"");
514           }
515           aVars.push_back(aVar);
516           if(MYDEBUG) {
517             cout<<"Variable: '"<<aVar<<"'"<<endl;
518           }
519         }
520         aState->AddState(aVars);
521       }
522       _objectMap.insert(pair<TCollection_AsciiString,ObjectStates*>(TCollection_AsciiString(aSObject->GetID()),aState));
523     }
524   }
525 }
526
527 //================================================================================
528 /*!
529  * 
530  */
531 //================================================================================
532 void SMESH_NoteBook::AddCommand(const TCollection_AsciiString& theString)
533 {
534   if(MYDEBUG)
535     cout<<theString<<endl;
536   Handle(_pyCommand) aCommand = new _pyCommand( theString, -1);
537   _commands.push_back(aCommand);
538
539   if ( aCommand->GetMethod() == "GetMeshEditor" ) { // MeshEditor creation
540     myMeshEditors.insert( make_pair( aCommand->GetResultValue(),
541                                      aCommand->GetObject() ) );
542   }
543 }
544
545 //================================================================================
546 /*!
547  * 
548  */
549 //================================================================================
550 void SMESH_NoteBook::ProcessLayerDistribution()
551 {
552   // 1) Find all LayerDistribution states
553   vector<LayerDistributionStates*> aLDS;
554   TVariablesMap::const_iterator it = _objectMap.begin();
555   for(;it != _objectMap.end();it++)
556     if(LayerDistributionStates* aLDStates = (LayerDistributionStates*)((*it).second)) {
557       aLDS.push_back(aLDStates);
558     }
559   
560   // 2) Initialize all type of 1D Distribution hypothesis
561   for(int i=0;i<_commands.size();i++){
562     for(int j =0;j < aLDS.size();j++){
563       TCollection_AsciiString aResultValue = _commands[i]->GetResultValue();
564       if(_commands[i]->GetMethod() == "CreateHypothesis" &&
565          aLDS[j]->HasDistribution(aResultValue)){
566         TCollection_AsciiString aType = _commands[i]->GetArg(1);
567         aType.RemoveAll('\'');
568         aLDS[j]->SetDistributionType(aResultValue,aType);
569       }
570     }
571   }
572   // 3) ... and replase variables ...
573
574   for(int i=0;i<_commands.size();i++){
575     for(int j =0;j < aLDS.size();j++){
576       TCollection_AsciiString anObject = _commands[i]->GetObject();
577
578       if(aLDS[j]->HasDistribution(anObject)) {
579         TCollection_AsciiString aType = aLDS[j]->GetDistributionType(anObject);
580         TCollection_AsciiString aMethod = _commands[i]->GetMethod();
581         if(aType == "LocalLength") {
582           if(aMethod == "SetLength") {
583             if(!aLDS[j]->GetCurrectState().at(0).IsEmpty() )
584               _commands[i]->SetArg(1,aLDS[j]->GetCurrectState().at(0));
585             aLDS[j]->IncrementState();
586           }
587           else if(aMethod == "SetPrecision") {
588             if(!aLDS[j]->GetCurrectState().at(1).IsEmpty() )
589               _commands[i]->SetArg(1,aLDS[j]->GetCurrectState().at(1));
590             aLDS[j]->IncrementState();
591           }
592         }
593       }
594     }
595   }
596 }
597 //================================================================================
598 /*!
599  *  \brief Return result script
600  */
601 //================================================================================
602 TCollection_AsciiString SMESH_NoteBook::GetResultScript() const
603 {
604   TCollection_AsciiString aResult;
605   for(int i=0;i<_commands.size();i++)
606     aResult+=_commands[i]->GetString()+"\n";
607   return aResult;
608 }