src/ModelHighAPI/ModelHighAPI_Tools.cpp

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #include "ModelHighAPI_Tools.h"
  22 #include <ModelHighAPI_FeatureStore.h>
  23 //--------------------------------------------------------------------------------------
  24 #include <GeomAPI_Dir.h>
  25 #include <GeomAPI_Pnt.h>
  26 #include <GeomAPI_Pnt2d.h>
  27 //--------------------------------------------------------------------------------------
  28 #include <GeomDataAPI_Dir.h>
  29 #include <GeomDataAPI_Point.h>
  30 #include <GeomDataAPI_Point2D.h>
  31 //--------------------------------------------------------------------------------------
  32 #include <ModelAPI_AttributeBoolean.h>
  33 #include <ModelAPI_AttributeDocRef.h>
  34 #include <ModelAPI_AttributeDouble.h>
  35 #include <ModelAPI_AttributeIntArray.h>
  36 #include <ModelAPI_AttributeInteger.h>
  37 #include <ModelAPI_AttributeRefAttr.h>
  38 #include <ModelAPI_AttributeRefAttrList.h>
  39 #include <ModelAPI_AttributeReference.h>
  40 #include <ModelAPI_AttributeRefList.h>
  41 #include <ModelAPI_AttributeSelection.h>
  42 #include <ModelAPI_AttributeSelectionList.h>
  43 #include <ModelAPI_AttributeString.h>
  44 #include <ModelAPI_AttributeStringArray.h>
  45 #include <ModelAPI_AttributeDoubleArray.h>
  46 #include <ModelAPI_Session.h>
  47 #include <ModelAPI_Tools.h>
  48 #include <ModelAPI_ResultPart.h>
  49 //--------------------------------------------------------------------------------------
  50 #include <Config_ModuleReader.h>
  51 //--------------------------------------------------------------------------------------
  52 #include "ModelHighAPI_Double.h"
  53 #include "ModelHighAPI_Integer.h"
  54 #include "ModelHighAPI_RefAttr.h"
  55 #include "ModelHighAPI_Reference.h"
  56 #include "ModelHighAPI_Selection.h"
  57
  58 #include <Events_InfoMessage.h>
  59
  60 // Have to be included before std headers
  61 #include <Python.h>
  62
  63 #include <algorithm>
  64 #include <iostream>
  65
  66 //--------------------------------------------------------------------------------------
  67 void fillAttribute(const std::shared_ptr<GeomAPI_Pnt2d> & theValue,
  68                    const std::shared_ptr<GeomDataAPI_Point2D> & theAttribute)
  69 {
  70   theAttribute->setValue(theValue);
  71 }
  72
  73 void fillAttribute(const std::shared_ptr<GeomDataAPI_Point2D> & theAttribute,
  74                    double theX, double theY)
  75 {
  76   theAttribute->setValue(theX, theY);
  77 }
  78
  79 //--------------------------------------------------------------------------------------
  80 void fillAttribute(const std::shared_ptr<GeomAPI_Dir> & theValue,
  81                    const std::shared_ptr<GeomDataAPI_Dir> & theAttribute)
  82 {
  83   theAttribute->setValue(theValue);
  84 }
  85
  86 //--------------------------------------------------------------------------------------
  87 void fillAttribute(const std::shared_ptr<GeomAPI_Pnt> & theValue,
  88                    const std::shared_ptr<GeomDataAPI_Point> & theAttribute)
  89 {
  90   theAttribute->setValue(theValue);
  91 }
  92
  93 //--------------------------------------------------------------------------------------
  94 void fillAttribute(bool theValue,
  95                    const std::shared_ptr<ModelAPI_AttributeBoolean> & theAttribute)
  96 {
  97   theAttribute->setValue(theValue);
  98 }
  99
 100 //--------------------------------------------------------------------------------------
 101 void fillAttribute(const ModelHighAPI_Double & theValue,
 102                    const std::shared_ptr<ModelAPI_AttributeDouble> & theAttribute)
 103 {
 104   theValue.fillAttribute(theAttribute);
 105 }
 106 void fillAttribute(double theValue,
 107                    const std::shared_ptr<ModelAPI_AttributeDouble> & theAttribute)
 108 {
 109   theAttribute->setValue(theValue);
 110 }
 111
 112 //--------------------------------------------------------------------------------------
 113 void fillAttribute(const ModelHighAPI_Integer & theValue,
 114                    const std::shared_ptr<ModelAPI_AttributeInteger> & theAttribute)
 115 {
 116   theValue.fillAttribute(theAttribute);
 117 }
 118 void fillAttribute(int theValue,
 119                    const std::shared_ptr<ModelAPI_AttributeInteger> & theAttribute)
 120 {
 121   theAttribute->setValue(theValue);
 122 }
 123
 124 //--------------------------------------------------------------------------------------
 125 void fillAttribute(const ModelHighAPI_RefAttr & theValue,
 126                    const std::shared_ptr<ModelAPI_AttributeRefAttr> & theAttribute)
 127 {
 128   theValue.fillAttribute(theAttribute);
 129 }
 130
 131 //--------------------------------------------------------------------------------------
 132 void fillAttribute(const std::list<ModelHighAPI_RefAttr> & theValue,
 133                    const std::shared_ptr<ModelAPI_AttributeRefAttrList> & theAttribute)
 134 {
 135   theAttribute->clear();
 136   for (auto it = theValue.begin(); it != theValue.end(); ++it)
 137     it->appendToList(theAttribute);
 138 }
 139
 140 //--------------------------------------------------------------------------------------
 141 void fillAttribute(const ModelHighAPI_Reference & theValue,
 142                    const std::shared_ptr<ModelAPI_AttributeReference> & theAttribute)
 143 {
 144   theValue.fillAttribute(theAttribute);
 145 }
 146
 147 //--------------------------------------------------------------------------------------
 148 void fillAttribute(const std::list<ModelHighAPI_Reference> & theValue,
 149                    const std::shared_ptr<ModelAPI_AttributeRefList> & theAttribute)
 150 {
 151   theAttribute->clear();
 152   for (auto it = theValue.begin(); it != theValue.end(); ++it)
 153     it->appendToList(theAttribute);
 154 }
 155
 156 //--------------------------------------------------------------------------------------
 157 void fillAttribute(const std::shared_ptr<ModelAPI_Object> & theValue,
 158                    const std::shared_ptr<ModelAPI_AttributeReference> & theAttribute)
 159 {
 160   theAttribute->setValue(theValue);
 161 }
 162
 163 //--------------------------------------------------------------------------------------
 164 void fillAttribute(const std::list<std::shared_ptr<ModelAPI_Object> > & theValue,
 165                    const std::shared_ptr<ModelAPI_AttributeRefList> & theAttribute)
 166 {
 167   theAttribute->clear();
 168   for (auto it = theValue.begin(); it != theValue.end(); ++it)
 169     theAttribute->append(*it);
 170 }
 171
 172 MODELHIGHAPI_EXPORT
 173 void fillAttribute(const std::list<ModelHighAPI_Selection> & theValue,
 174                    const std::shared_ptr<ModelAPI_AttributeRefList> & theAttribute)
 175 {
 176   theAttribute->clear();
 177   for (auto it = theValue.begin(); it != theValue.end(); ++it) {
 178     if (it->resultSubShapePair().first)
 179       theAttribute->append(it->resultSubShapePair().first); // use only context
 180   }
 181 }
 182
 183 //--------------------------------------------------------------------------------------
 184 void fillAttribute(const ModelHighAPI_Selection & theValue,
 185                    const std::shared_ptr<ModelAPI_AttributeSelection> & theAttribute)
 186 {
 187   theValue.fillAttribute(theAttribute);
 188 }
 189
 190 //--------------------------------------------------------------------------------------
 191 void fillAttribute(const std::list<ModelHighAPI_Selection> & theValue,
 192                    const std::shared_ptr<ModelAPI_AttributeSelectionList> & theAttribute)
 193 {
 194   theAttribute->clear();
 195
 196   if(!theValue.empty()) {
 197     const ModelHighAPI_Selection& aSelection = theValue.front();
 198     std::string aSelectionType = aSelection.shapeType();
 199     GeomAPI_Shape::ShapeType aType = GeomAPI_Shape::shapeTypeByStr(aSelectionType);
 200     if (aType != GeomAPI_Shape::SHAPE || aSelectionType == "SHAPE")
 201       theAttribute->setSelectionType(aSelectionType);
 202   }
 203
 204   for (auto it = theValue.begin(); it != theValue.end(); ++it)
 205     it->appendToList(theAttribute);
 206 }
 207
 208 //--------------------------------------------------------------------------------------
 209 void fillAttribute(const std::string & theValue,
 210                    const std::shared_ptr<ModelAPI_AttributeString> & theAttribute)
 211 {
 212   theAttribute->setValue(theValue);
 213 }
 214
 215 //--------------------------------------------------------------------------------------
 216 void fillAttribute(const char * theValue,
 217                    const std::shared_ptr<ModelAPI_AttributeString> & theAttribute)
 218 {
 219   theAttribute->setValue(theValue);
 220 }
 221
 222 //--------------------------------------------------------------------------------------
 223 void fillAttribute(const std::list<std::string> & theValue,
 224                    const std::shared_ptr<ModelAPI_AttributeStringArray> & theAttribute)
 225 {
 226   theAttribute->setSize(int(theValue.size()));
 227
 228   int anIndex = 0;
 229   for (auto it = theValue.begin(); it != theValue.end(); ++it, ++anIndex)
 230     theAttribute->setValue(anIndex, *it);
 231 }
 232
 233 //--------------------------------------------------------------------------------------
 234 void fillAttribute(const std::list<ModelHighAPI_Integer> & theValue,
 235                    const std::shared_ptr<ModelAPI_AttributeIntArray> & theAttribute)
 236 {
 237   theAttribute->setSize(int(theValue.size()));
 238
 239   int anIndex = 0;
 240   for (auto it = theValue.begin(); it != theValue.end(); ++it, ++anIndex)
 241     theAttribute->setValue(anIndex, it->intValue()); // use only values, no text support in array
 242 }
 243
 244 void fillAttribute(const ModelHighAPI_Double & theX,
 245                    const ModelHighAPI_Double & theY,
 246                    const ModelHighAPI_Double & theZ,
 247                    const std::shared_ptr<GeomDataAPI_Point> & theAttribute)
 248 {
 249   theX.fillAttribute(theAttribute, theX, theY, theZ);
 250 }
 251
 252
 253 //==================================================================================================
 254 GeomAPI_Shape::ShapeType shapeTypeByStr(std::string theShapeTypeStr)
 255 {
 256   GeomAPI_Shape::ShapeType aShapeType = GeomAPI_Shape::SHAPE;
 257
 258   std::transform(theShapeTypeStr.begin(), theShapeTypeStr.end(),
 259                  theShapeTypeStr.begin(), ::tolower);
 260
 261   if(theShapeTypeStr == "compound") {
 262     aShapeType = GeomAPI_Shape::COMPOUND;
 263   } else if(theShapeTypeStr == "compsolid") {
 264     aShapeType = GeomAPI_Shape::COMPSOLID;
 265   } else if(theShapeTypeStr == "solid") {
 266     aShapeType = GeomAPI_Shape::SOLID;
 267   } else if(theShapeTypeStr == "shell") {
 268     aShapeType = GeomAPI_Shape::SHELL;
 269   } else if(theShapeTypeStr == "face") {
 270     aShapeType = GeomAPI_Shape::FACE;
 271   } else if(theShapeTypeStr == "wire") {
 272     aShapeType = GeomAPI_Shape::WIRE;
 273   } else if(theShapeTypeStr == "edge") {
 274     aShapeType = GeomAPI_Shape::EDGE;
 275   } else if(theShapeTypeStr == "vertex") {
 276     aShapeType = GeomAPI_Shape::VERTEX;
 277   } else if(theShapeTypeStr == "shape") {
 278     aShapeType = GeomAPI_Shape::SHAPE;
 279   }
 280
 281   return aShapeType;
 282 }
 283
 284 //==================================================================================================
 285 GeomAPI_Shape::ShapeType getShapeType(const ModelHighAPI_Selection& theSelection)
 286 {
 287   GeomAPI_Shape::ShapeType aShapeType = GeomAPI_Shape::SHAPE;
 288
 289   switch(theSelection.variantType()) {
 290     case ModelHighAPI_Selection::VT_ResultSubShapePair: {
 291       ResultSubShapePair aPair = theSelection.resultSubShapePair();
 292       GeomShapePtr aShape = aPair.second;
 293       if(!aShape.get()) {
 294         aShape = aPair.first->shape();
 295       }
 296       if(!aShape.get()) {
 297         return aShapeType;
 298       }
 299       aShapeType = aShape->shapeType();
 300       break;
 301     }
 302     case ModelHighAPI_Selection::VT_TypeSubShapeNamePair: {
 303       TypeSubShapeNamePair aPair = theSelection.typeSubShapeNamePair();
 304       std::string aType = aPair.first;
 305       aShapeType = shapeTypeByStr(aType);
 306       break;
 307     }
 308   }
 309
 310   return aShapeType;
 311 }
 312
 313 //--------------------------------------------------------------------------------------
 314 ModelAPI_AttributeTables::ValueType valueTypeByStr(const std::string& theValueTypeStr)
 315 {
 316   std::string aType = theValueTypeStr;
 317   std::transform(aType.begin(), aType.end(), aType.begin(), ::tolower);
 318   if (aType == "boolean")
 319     return ModelAPI_AttributeTables::BOOLEAN;
 320   else if (aType == "integer")
 321     return ModelAPI_AttributeTables::INTEGER;
 322   else if (aType == "string")
 323     return ModelAPI_AttributeTables::STRING;
 324   return ModelAPI_AttributeTables::DOUBLE; // default
 325 }
 326
 327 //--------------------------------------------------------------------------------------
 328 std::string strByValueType(const ModelAPI_AttributeTables::ValueType theType)
 329 {
 330   switch(theType) {
 331   case ModelAPI_AttributeTables::BOOLEAN: return "BOOLEAN";
 332   case ModelAPI_AttributeTables::INTEGER: return "INTEGER";
 333   case ModelAPI_AttributeTables::DOUBLE: return "DOUBLE";
 334   case ModelAPI_AttributeTables::STRING: return "STRING";
 335   }
 336   return ""; // bad case
 337 }
 338
 339 /// stores the features information, recoursively stores sub-documetns features
 340 std::string storeFeatures(const std::string& theDocName, DocumentPtr theDoc,
 341   std::map<std::string, std::map<std::string, ModelHighAPI_FeatureStore> >& theStore,
 342   const bool theCompare) // if false => store
 343 {
 344   std::map<std::string, std::map<std::string, ModelHighAPI_FeatureStore> >::iterator aDocFind;
 345   if (theCompare) {
 346      aDocFind = theStore.find(theDocName);
 347      if (aDocFind == theStore.end()) {
 348        return "Document '" + theDocName + "' not found";
 349      }
 350   }
 351   // store the model features information: iterate all features
 352   int anObjectsCount = 0; // stores the number of compared features for this document to compate
 353   std::set<std::string> aProcessed; // processed features names (that are in the current document)
 354
 355   // process all objects (features and folders)
 356   std::list<ObjectPtr> allObjects = theDoc->allObjects();
 357   std::list<ObjectPtr>::iterator allIter = allObjects.begin();
 358   for(; allIter != allObjects.end(); allIter++) {
 359     ObjectPtr anObject = *allIter;
 360     if (theCompare) {
 361       std::map<std::string, ModelHighAPI_FeatureStore>::iterator
 362         anObjFind = aDocFind->second.find(anObject->data()->name());
 363       if (anObjFind == aDocFind->second.end()) {
 364         return "Document '" + theDocName + "' feature '" + anObject->data()->name() + "' not found";
 365       }
 366       std::string anError = anObjFind->second.compare(anObject);
 367       if (!anError.empty()) {
 368         anError = "Document " + theDocName + " " + anError;
 369         return anError;
 370       }
 371       anObjectsCount++;
 372       aProcessed.insert(anObject->data()->name());
 373     } else {
 374       theStore[theDocName][anObject->data()->name()] = ModelHighAPI_FeatureStore(anObject);
 375     }
 376
 377     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
 378     if (aFeature) {
 379       // iterate all results of this feature
 380       std::list<ResultPtr> allResults;
 381       ModelAPI_Tools::allResults(aFeature, allResults);
 382       std::list<ResultPtr>::iterator aRes = allResults.begin();
 383       for(; aRes != allResults.end(); aRes++) {
 384         // recoursively store features of sub-documents
 385         if ((*aRes)->groupName() == ModelAPI_ResultPart::group()) {
 386           DocumentPtr aDoc = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes)->partDoc();
 387           if (aDoc.get()) {
 388             std::string anError =
 389                 storeFeatures((*aRes)->data()->name(), aDoc, theStore, theCompare);
 390             if (!anError.empty())
 391               return anError;
 392           }
 393         }
 394       }
 395     }
 396   }
 397   // checks the number of compared features
 398   if (theCompare) {
 399     if (aDocFind->second.size() != anObjectsCount) {
 400       // search for disappeared feature
 401       std::string aLostName;
 402       std::map<std::string, ModelHighAPI_FeatureStore>::iterator aLostIter;
 403       for(aLostIter = aDocFind->second.begin(); aLostIter != aDocFind->second.end(); aLostIter++) {
 404         if (aProcessed.find(aLostIter->first) == aProcessed.end()) {
 405           aLostName = aLostIter->first;
 406         }
 407       }
 408       return "For document '" + theDocName +
 409         "' the number of features is decreased, there is no feature '" + aLostName + "'";
 410     }
 411   }
 412   return ""; // ok
 413 }
 414
 415 //==================================================================================================
 416 typedef std::map<std::string, std::map<std::string, ModelHighAPI_FeatureStore> > Storage;
 417
 418 static bool dumpToPython(SessionPtr theSession,
 419                          const char* theFilename,
 420                          bool theDumpByGeom,
 421                          const std::string& theErrorMsgContext)
 422 {
 423   // 2431: set PartSet as a current document
 424   theSession->setActiveDocument(theSession->moduleDocument(), true);
 425   // dump all to the python file
 426   theSession->startOperation("Check python dump");
 427   FeaturePtr aDump = theSession->moduleDocument()->addFeature("Dump");
 428   if (aDump.get()) {
 429     aDump->string("file_path")->setValue(theFilename);
 430     aDump->string("file_format")->setValue("py");
 431     aDump->boolean("geometric_dump")->setValue(theDumpByGeom);
 432     aDump->execute();
 433   }
 434   bool isProblem = !aDump.get() || !aDump->error().empty(); // after "finish" dump will be removed
 435   if (isProblem && aDump.get()) {
 436     std::cout << "Dump feature error " << aDump->error() << std::endl;
 437     Events_InfoMessage anErrorMsg(theErrorMsgContext, aDump->error());
 438     anErrorMsg.send();
 439   }
 440   theSession->finishOperation();
 441   return !isProblem;
 442 }
 443
 444 static bool checkDump(SessionPtr theSession,
 445                       char* theFilename,
 446                       Storage& theStorage,
 447                       const std::string& theErrorMsgContext)
 448 {
 449
 450   // close all before importation of the script
 451   theSession->closeAll();
 452
 453
 454   // execute the dumped
 455   PyGILState_STATE gstate = PyGILState_Ensure(); /* acquire python thread */
 456   static char aReadMode[] = "r";
 457   PyObject* PyFileObject = PyFile_FromString(theFilename, aReadMode);
 458   PyRun_SimpleFileEx(PyFile_AsFile(PyFileObject), theFilename, 1);
 459   PyGILState_Release(gstate); /* release python thread */
 460
 461   // compare with the stored data
 462   std::string anError = storeFeatures(
 463     theSession->moduleDocument()->kind(), theSession->moduleDocument(), theStorage, true);
 464   if (!anError.empty()) {
 465     std::cout << anError << std::endl;
 466     Events_InfoMessage anErrorMsg(theErrorMsgContext, anError);
 467     anErrorMsg.send();
 468     return false;
 469   }
 470
 471   return true;
 472 }
 473
 474 bool checkPythonDump()
 475 {
 476   static const std::string anErrorByNaming("checkPythonDump by naming");
 477   static const std::string anErrorByGeometry("checkPythonDump by geometry");
 478
 479   static char aFileForNamingDump[] = "./check_dump_byname.py";
 480   static char aFileForGeometryDump[] = "./check_dump_bygeom.py";
 481
 482   SessionPtr aSession = ModelAPI_Session::get();
 483   // dump with the selection by names
 484   if (!dumpToPython(aSession, aFileForNamingDump, false, anErrorByNaming))
 485     return false;
 486   // dump with the selection by geometry
 487   if (!dumpToPython(aSession, aFileForGeometryDump, true, anErrorByGeometry))
 488     return false;
 489
 490    // map from document name to feature name to feature data
 491   std::map<std::string, std::map<std::string, ModelHighAPI_FeatureStore> > aStore;
 492   std::string anError = storeFeatures(
 493     aSession->moduleDocument()->kind(), aSession->moduleDocument(), aStore, false);
 494   if (!anError.empty()) {
 495     Events_InfoMessage anErrorMsg(std::string("checkPythonDump"), anError);
 496     anErrorMsg.send();
 497     return false;
 498   }
 499
 500   // check dump with the selection by names
 501   bool isOk = checkDump(aSession, aFileForNamingDump, aStore, anErrorByNaming);
 502   // check dump with the selection by geometry
 503   isOk = isOk && checkDump(aSession, aFileForGeometryDump, aStore, anErrorByGeometry);
 504
 505   return isOk;
 506 }
 507
 508 //--------------------------------------------------------------------------------------