src/Model/Model_Update.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_Update.cxx
   4 // Created:     25 Jun 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #include <Model_Update.h>
   8 #include <Model_Document.h>
   9 #include <Model_Data.h>
  10 #include <ModelAPI_Feature.h>
  11 #include <ModelAPI_Data.h>
  12 #include <ModelAPI_Document.h>
  13 #include <ModelAPI_Events.h>
  14 #include <ModelAPI_AttributeReference.h>
  15 #include <ModelAPI_AttributeRefList.h>
  16 #include <ModelAPI_AttributeRefAttr.h>
  17 #include <ModelAPI_AttributeSelection.h>
  18 #include <ModelAPI_AttributeSelectionList.h>
  19 #include <ModelAPI_Result.h>
  20 #include <ModelAPI_ResultPart.h>
  21 #include <ModelAPI_Validator.h>
  22 #include <ModelAPI_CompositeFeature.h>
  23 #include <ModelAPI_Session.h>
  24 #include <ModelAPI_Tools.h>
  25 #include <Events_Loop.h>
  26 #include <Events_LongOp.h>
  27 #include <Events_Error.h>
  28 #include <Config_PropManager.h>
  29
  30 using namespace std;
  31
  32 Model_Update MY_UPDATER_INSTANCE;  /// the only one instance initialized on load of the library
  33
  34 Model_Update::Model_Update()
  35 {
  36   Events_Loop* aLoop = Events_Loop::loop();
  37   static const Events_ID kChangedEvent = aLoop->eventByName("PreferenceChanged");
  38   aLoop->registerListener(this, kChangedEvent);
  39   static const Events_ID kRebuildEvent = aLoop->eventByName("Rebuild");
  40   aLoop->registerListener(this, kRebuildEvent);
  41   static const Events_ID kCreatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED);
  42   aLoop->registerListener(this, kCreatedEvent);
  43   static const Events_ID kUpdatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
  44   aLoop->registerListener(this, kUpdatedEvent);
  45   static const Events_ID kMovedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_MOVED);
  46   aLoop->registerListener(this, kMovedEvent);
  47   static const Events_ID kOpFinishEvent = aLoop->eventByName("FinishOperation");
  48   aLoop->registerListener(this, kOpFinishEvent);
  49   static const Events_ID kOpAbortEvent = aLoop->eventByName("AbortOperation");
  50   aLoop->registerListener(this, kOpAbortEvent);
  51   static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
  52   aLoop->registerListener(this, kOpStartEvent);
  53
  54   Config_PropManager::registerProp("Model update", "automatic_rebuild", "Rebuild immediately",
  55                                    Config_Prop::Boolean, "false");
  56   myIsAutomatic =
  57     Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
  58 }
  59
  60 void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessage)
  61 {
  62   static Events_Loop* aLoop = Events_Loop::loop();
  63   static const Events_ID kChangedEvent = aLoop->eventByName("PreferenceChanged");
  64   static const Events_ID kRebuildEvent = aLoop->eventByName("Rebuild");
  65   static const Events_ID kCreatedEvent = aLoop->eventByName(EVENT_OBJECT_CREATED);
  66   static const Events_ID kUpdatedEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
  67   static const Events_ID kMovedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_MOVED);
  68   static const Events_ID kOpFinishEvent = aLoop->eventByName("FinishOperation");
  69   static const Events_ID kOpAbortEvent = aLoop->eventByName("AbortOperation");
  70   static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
  71   bool isOperationChanged = false;
  72   if (theMessage->eventID() == kChangedEvent) { // automatic and manual rebuild flag is changed
  73     bool aPropVal =
  74       Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
  75     if (aPropVal != myIsAutomatic) { // something is changed
  76       myIsAutomatic = aPropVal;
  77       if (myIsAutomatic) // higher level of automatization => to rebuild
  78         processOperation(false);
  79     }
  80   } else if (theMessage->eventID() == kRebuildEvent) { // the rebuild command
  81     processOperation(true);
  82   } else if (theMessage->eventID() == kCreatedEvent || theMessage->eventID() == kUpdatedEvent ||
  83              theMessage->eventID() == kMovedEvent) {
  84     std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aMsg =
  85         std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
  86     const std::set<ObjectPtr>& anObjs = aMsg->objects();
  87     std::set<ObjectPtr>::const_iterator anObjIter = anObjs.cbegin();
  88     for(; anObjIter != anObjs.cend(); anObjIter++) {
  89       // created objects are always must be up to date (python box feature)
  90       // and updated not in internal uptation chain
  91       if (theMessage->eventID() == kCreatedEvent) {
  92         myJustCreated.insert(*anObjIter);
  93       } else if (myJustCreated.find(*anObjIter) == myJustCreated.end()) { // moved and updated
  94         myJustUpdated.insert(*anObjIter);
  95       }
  96     }
  97      // this event is for solver update, not here, do not react immideately
  98     if (!(theMessage->eventID() == kMovedEvent))
  99       processOperation(false);
 100   } else if (theMessage->eventID() == kOpStartEvent) {
 101     // we don't need the update only on operation start (caused problems in PartSet_Listener::processEvent)
 102     isOperationChanged = true;
 103   } else if (theMessage->eventID() == kOpFinishEvent || theMessage->eventID() == kOpAbortEvent) {
 104     processOperation(true);
 105     isOperationChanged = true;
 106   }
 107   if (isOperationChanged) {
 108     // remove all macros before clearing all created
 109     std::set<ObjectPtr>::iterator aCreatedIter = myJustCreated.begin();
 110     for(; aCreatedIter != myJustCreated.end(); aCreatedIter++) {
 111       FeaturePtr aFeature =
 112         std::dynamic_pointer_cast<ModelAPI_Feature>(*aCreatedIter);
 113       if (aFeature.get() && aFeature->isMacro()) {
 114         aFeature->document()->removeFeature(aFeature);
 115       }
 116     }
 117     myJustCreated.clear();
 118     myJustUpdated.clear();
 119   }
 120 }
 121
 122 void Model_Update::processOperation(const bool theTotalUpdate)
 123 {
 124   // the hardcode (DBC asked): hide the sketch referenced by extrusion on apply
 125   std::set<std::shared_ptr<ModelAPI_Object> >::iterator aFIter;
 126   for(aFIter = myJustCreated.begin(); aFIter != myJustCreated.end(); aFIter++)
 127   {
 128     FeaturePtr aF = std::dynamic_pointer_cast<ModelAPI_Feature>(*aFIter);
 129     if (aF && aF->data().get() && aF->getKind() == "Extrusion") {
 130       AttributeSelectionListPtr aBase = aF->selectionList("base");
 131       if (aBase.get()) {
 132         for(int a = aBase->size() - 1; a >= 0; a--) {
 133           ResultPtr aSketchRes = aBase->value(a)->context();
 134           if (aSketchRes) {
 135             static Events_ID HIDE_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TOHIDE);
 136             ModelAPI_EventCreator::get()->sendUpdated(aSketchRes, HIDE_DISP);
 137           }
 138         }
 139       }
 140     }
 141   }
 142   // perform update of everything if needed
 143   if (!myIsExecuted) {
 144     myIsExecuted = true;
 145
 146     bool isAutomaticChanged = false;
 147
 148     if (theTotalUpdate && !myIsAutomatic) { // Apply button now works as "Rebuild"
 149       isAutomaticChanged = true;
 150       myIsAutomatic = true;
 151     }
 152
 153     updateInDoc(ModelAPI_Session::get()->moduleDocument());
 154
 155     if (isAutomaticChanged) myIsAutomatic = false;
 156     myIsExecuted = false;
 157
 158     // flush to update display
 159     static Events_Loop* aLoop = Events_Loop::loop();
 160     static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 161     aLoop->flush(EVENT_DISP);
 162   }
 163 }
 164
 165 void Model_Update::updateInDoc(std::shared_ptr<ModelAPI_Document> theDoc)
 166 {
 167   std::set<FeaturePtr> alreadyProcessed; // features that are processed before others
 168   // all features one by one
 169   for (int aFIndex = 0; aFIndex < theDoc->size(ModelAPI_Feature::group(), true); aFIndex++) {
 170     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
 171       theDoc->object(ModelAPI_Feature::group(), aFIndex, true));
 172     if (aFeature && alreadyProcessed.find(aFeature) == alreadyProcessed.end()) {
 173       // update selection and parameters attributes first, before sub-features analysis (sketch plane)
 174       updateArguments(aFeature);
 175       // composite feature must be executed after sub-features execution
 176       CompositeFeaturePtr aComposite =
 177         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
 178       if (aComposite) {
 179         // number of subs can be changed in execution: like fillet
 180         for(int a = 0; a < aComposite->numberOfSubs(); a++) {
 181           FeaturePtr aSub = aComposite->subFeature(a);
 182           updateFeature(aSub);
 183           alreadyProcessed.insert(aSub);
 184         }
 185       }
 186
 187       updateFeature(aFeature);
 188       // update the document results recursively
 189       const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
 190       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
 191       for (; aRIter != aResults.cend(); aRIter++) {
 192         ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRIter);
 193         if (aPart.get()) {
 194           updateInDoc(aPart->partDoc());
 195         }
 196       }
 197     }
 198   }
 199 }
 200
 201 void Model_Update::redisplayWithResults(FeaturePtr theFeature, const ModelAPI_ExecState theState)
 202 {
 203   // make updated and redisplay all results
 204   static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 205   const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
 206   std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
 207   for (; aRIter != aResults.cend(); aRIter++) {
 208     std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
 209     aRes->data()->execState(theState);
 210     myJustUpdated.insert(aRes);
 211     ModelAPI_EventCreator::get()->sendUpdated(aRes, EVENT_DISP);
 212   }
 213   // to redisplay "presentable" feature (for ex. distance constraint)
 214   ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
 215   theFeature->data()->execState(theState);
 216 }
 217
 218 /// Updates the state by the referenced object: if something bad with it, set state for this one
 219 ModelAPI_ExecState stateByReference(ObjectPtr theTarget, const ModelAPI_ExecState theCurrent)
 220 {
 221   if (theTarget) {
 222     ModelAPI_ExecState aRefState = theTarget->data()->execState();
 223     if (aRefState == ModelAPI_StateMustBeUpdated) {
 224       return ModelAPI_StateMustBeUpdated;
 225     } else if (aRefState != ModelAPI_StateDone) {
 226       return ModelAPI_StateInvalidArgument;
 227     }
 228   }
 229   return theCurrent;
 230 }
 231
 232 void Model_Update::updateArguments(FeaturePtr theFeature) {
 233   static ModelAPI_ValidatorsFactory* aFactory = ModelAPI_Session::get()->validators();
 234
 235   bool aJustUpdated = false;
 236   ModelAPI_ExecState aState = ModelAPI_StateDone;
 237   // check the parameters: values can be changed
 238   std::list<AttributePtr> aDoubles =
 239     theFeature->data()->attributes(ModelAPI_AttributeDouble::typeId());
 240   std::list<AttributePtr>::iterator aDoubleIter = aDoubles.begin();
 241   for(; aDoubleIter != aDoubles.end(); aDoubleIter++) {
 242     AttributeDoublePtr aDouble =
 243       std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(*aDoubleIter);
 244     if (aDouble.get() && !aDouble->text().empty()) {
 245       double aNewVal;
 246       if (ModelAPI_Tools::findVariable(aDouble->text(), aNewVal)) {
 247         if (aNewVal != aDouble->value()) {
 248           aDouble->setValue(aNewVal);
 249           aJustUpdated = true;
 250         }
 251       } else {
 252         aState = ModelAPI_StateInvalidArgument;
 253       }
 254     }
 255   }
 256
 257   if (aState == ModelAPI_StateDone) {// all referenced objects are ready to be used
 258     //std::cout<<"Execute feature "<<theFeature->getKind()<<std::endl;
 259     // before execution update the selection attributes if any
 260     list<AttributePtr> aRefs =
 261       theFeature->data()->attributes(ModelAPI_AttributeSelection::typeId());
 262     list<AttributePtr>::iterator aRefsIter = aRefs.begin();
 263     for (; aRefsIter != aRefs.end(); aRefsIter++) {
 264       std::shared_ptr<ModelAPI_AttributeSelection> aSel =
 265         std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(*aRefsIter);
 266       if (!aSel->update()) { // this must be done on execution since it may be long operation
 267         if (!aFactory->isNotObligatory(theFeature->getKind(), theFeature->data()->id(aSel)) &&
 268             aFactory->isCase(theFeature, theFeature->data()->id(aSel)))
 269           aState = ModelAPI_StateInvalidArgument;
 270       }
 271     }
 272     aRefs = theFeature->data()->attributes(ModelAPI_AttributeSelectionList::typeId());
 273     for (aRefsIter = aRefs.begin(); aRefsIter != aRefs.end(); aRefsIter++) {
 274       std::shared_ptr<ModelAPI_AttributeSelectionList> aSel =
 275         std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(*aRefsIter);
 276       for(int a = aSel->size() - 1; a >= 0; a--) {
 277         std::shared_ptr<ModelAPI_AttributeSelection> aSelAttr =
 278           std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(aSel->value(a));
 279         if (aSelAttr) {
 280           if (!aSelAttr->update()) {
 281             if (!aFactory->isNotObligatory(
 282                   theFeature->getKind(), theFeature->data()->id(aSel)) &&
 283                 aFactory->isCase(theFeature, theFeature->data()->id(aSel)))
 284               aState = ModelAPI_StateInvalidArgument;
 285           }
 286         }
 287       }
 288     }
 289   }
 290   if (aJustUpdated && myJustCreated.find(theFeature) == myJustCreated.end())
 291   myJustUpdated.insert(theFeature);
 292   if (aState != ModelAPI_StateDone)
 293     theFeature->data()->execState(aState);
 294 }
 295
 296 void Model_Update::updateFeature(FeaturePtr theFeature)
 297 {
 298   // check all features this feature depended on (recursive call of updateFeature)
 299   static ModelAPI_ValidatorsFactory* aFactory = ModelAPI_Session::get()->validators();
 300   bool aJustUpdated = false;
 301
 302   if (theFeature) {
 303     if (theFeature->data()->execState() != ModelAPI_StateDone)
 304       aJustUpdated = true;
 305
 306     ModelAPI_ExecState aState = ModelAPI_StateDone;
 307
 308     // check all references: if referenced objects are updated, this object also must be updated
 309     // also check state of referenced objects: if they are not ready, inherit corresponding state
 310     std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
 311     std::shared_ptr<Model_Data> aData =
 312       std::dynamic_pointer_cast<Model_Data>(theFeature->data());
 313     aData->referencesToObjects(aRefs);
 314     std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRef = aRefs.begin();
 315     for(; aRef != aRefs.end(); aRef++) {
 316       std::list<ObjectPtr>::iterator aRefObj = aRef->second.begin();
 317       for(; aRefObj != aRef->second.end(); aRefObj++) {
 318         if (myJustCreated.find(*aRefObj) != myJustCreated.end() ||
 319             myJustUpdated.find(*aRefObj) != myJustUpdated.end()) {
 320           aJustUpdated = true;
 321         }
 322         aState = stateByReference(*aRefObj, aState);
 323       }
 324     }
 325
 326     // some arguments were changed, so, this feature must be updated
 327     if (myJustCreated.find(theFeature) != myJustCreated.end()) {
 328       aJustUpdated = true;
 329     } else {
 330       if (aJustUpdated) {
 331         if (myJustUpdated.find(theFeature) == myJustUpdated.end())
 332           myJustUpdated.insert(theFeature);
 333       } else {
 334         aJustUpdated = myJustUpdated.find(theFeature) != myJustUpdated.end();
 335       }
 336     }
 337     //std::cout<<"Update feature "<<theFeature->getKind()<<" must be updated = "<<aMustbeUpdated<<std::endl;
 338     // execute feature if it must be updated
 339     if (aJustUpdated) {
 340       if (std::dynamic_pointer_cast<Model_Document>(theFeature->document())->executeFeatures() ||
 341           !theFeature->isPersistentResult()) {
 342         if (aFactory->validate(theFeature)) {
 343           if (myIsAutomatic ||
 344               (myJustCreated.find(theFeature) != myJustCreated.end() ||
 345               !theFeature->isPersistentResult() /* execute quick, not persistent results */))
 346           {
 347             // execute in try-catch to avoid internal problems of the feature
 348             if (aState == ModelAPI_StateDone || aState == ModelAPI_StateMustBeUpdated) {
 349               theFeature->data()->execState(ModelAPI_StateDone);
 350               try {
 351                 theFeature->execute();
 352                 if (theFeature->data()->execState() != ModelAPI_StateDone) {
 353                   aState = ModelAPI_StateExecFailed;
 354                 } else {
 355                   aState = ModelAPI_StateDone;
 356                 }
 357               } catch(...) {
 358                 aState = ModelAPI_StateExecFailed;
 359                 Events_Error::send(
 360                   "Feature " + theFeature->getKind() + " has failed during the execution");
 361               }
 362             }
 363             if (aState != ModelAPI_StateDone) {
 364               theFeature->eraseResults();
 365             }
 366             redisplayWithResults(theFeature, aState);
 367           } else { // must be updatet, but not updated yet
 368             theFeature->data()->execState(ModelAPI_StateMustBeUpdated);
 369             const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
 370             std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
 371             for (; aRIter != aResults.cend(); aRIter++) {
 372               std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
 373               aRes->data()->execState(ModelAPI_StateMustBeUpdated);
 374             }
 375           }
 376         } else {
 377           theFeature->eraseResults();
 378           redisplayWithResults(theFeature, ModelAPI_StateInvalidArgument); // result also must be updated
 379         }
 380       } else { // for automatically updated features (on abort, etc) it is necessary to redisplay anyway
 381         redisplayWithResults(theFeature, ModelAPI_StateNothing);
 382       }
 383     }
 384   }
 385 }