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