1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Update.cxx
4 // Created: 25 Jun 2014
5 // Author: Mikhail PONIKAROV
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_Validator.h>
21 #include <ModelAPI_CompositeFeature.h>
22 #include <ModelAPI_Session.h>
23 #include <ModelAPI_Tools.h>
24 #include <Events_Loop.h>
25 #include <Events_LongOp.h>
26 #include <Events_Error.h>
27 #include <Config_PropManager.h>
31 Model_Update MY_UPDATER_INSTANCE; /// the only one instance initialized on load of the library
33 Model_Update::Model_Update()
35 Events_Loop* aLoop = Events_Loop::loop();
36 static const Events_ID kChangedEvent = aLoop->eventByName("PreferenceChanged");
37 aLoop->registerListener(this, kChangedEvent);
38 static const Events_ID kRebuildEvent = aLoop->eventByName("Rebuild");
39 aLoop->registerListener(this, kRebuildEvent);
40 static const Events_ID kCreatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED);
41 aLoop->registerListener(this, kCreatedEvent);
42 static const Events_ID kUpdatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
43 aLoop->registerListener(this, kUpdatedEvent);
44 static const Events_ID kMovedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_MOVED);
45 aLoop->registerListener(this, kMovedEvent);
46 static const Events_ID kOpFinishEvent = aLoop->eventByName("FinishOperation");
47 aLoop->registerListener(this, kOpFinishEvent);
48 static const Events_ID kOpAbortEvent = aLoop->eventByName("AbortOperation");
49 aLoop->registerListener(this, kOpAbortEvent);
50 static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
51 aLoop->registerListener(this, kOpStartEvent);
53 Config_PropManager::registerProp("Model update", "automatic_rebuild", "Rebuild immediately",
54 Config_Prop::Boolean, "false");
56 Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
59 void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessage)
61 static Events_Loop* aLoop = Events_Loop::loop();
62 static const Events_ID kChangedEvent = aLoop->eventByName("PreferenceChanged");
63 static const Events_ID kRebuildEvent = aLoop->eventByName("Rebuild");
64 static const Events_ID kCreatedEvent = aLoop->eventByName(EVENT_OBJECT_CREATED);
65 static const Events_ID kUpdatedEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
66 static const Events_ID kMovedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_MOVED);
67 static const Events_ID kOpFinishEvent = aLoop->eventByName("FinishOperation");
68 static const Events_ID kOpAbortEvent = aLoop->eventByName("AbortOperation");
69 static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
70 bool isAutomaticChanged = false;
71 if (theMessage->eventID() == kChangedEvent) { // automatic and manual rebuild flag is changed
73 Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
74 if (aPropVal == myIsAutomatic)
75 return; // nothing is changed, so nithing to do
76 myIsAutomatic = aPropVal;
78 return; // less automatization => nothing to do
79 } else if (theMessage->eventID() == kRebuildEvent) { // the rebuild command
80 if (myIsAutomatic == false) {
81 isAutomaticChanged = true;
84 } else if (theMessage->eventID() == kCreatedEvent || theMessage->eventID() == kUpdatedEvent ||
85 theMessage->eventID() == kMovedEvent) {
86 std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aMsg =
87 std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
88 const std::set<ObjectPtr>& anObjs = aMsg->objects();
89 std::set<ObjectPtr>::const_iterator anObjIter = anObjs.cbegin();
90 for(; anObjIter != anObjs.cend(); anObjIter++) {
91 myJustCreatedOrUpdated.insert(*anObjIter);
92 // created objects are always must be up to date (python box feature)
93 // and updated not in internal uptation chain
94 if (!myIsExecuted || theMessage->eventID() == kCreatedEvent)
95 myInitial.insert(*anObjIter);
96 // TODO(mpv): check the next line. Came into dev 0.6.1 from BR_PYTHON_PLUGIN
97 // (*anObjIter)->data()->mustBeUpdated(true); // object must be updated because it was changed
99 if (theMessage->eventID() == kMovedEvent)
100 return; // this event is for solver update, not here
101 } else if (theMessage->eventID() == kOpStartEvent) {
102 myJustCreatedOrUpdated.clear();
104 return; // we don't need the update only on operation start (caused problems in PartSet_Listener::processEvent)
105 } else if (theMessage->eventID() == kOpFinishEvent || theMessage->eventID() == kOpAbortEvent) {
106 if (myIsAutomatic == false) { // Apply button now works as "Rebuild"
107 isAutomaticChanged = true;
108 myIsAutomatic = true;
110 // the hardcode (DBC asked): hide the sketch referenced by extrusion on apply
111 if (theMessage->eventID() == kOpFinishEvent) {
112 std::set<std::shared_ptr<ModelAPI_Object> >::iterator aFIter;
113 for(aFIter = myJustCreatedOrUpdated.begin(); aFIter != myJustCreatedOrUpdated.end(); aFIter++)
115 FeaturePtr aF = std::dynamic_pointer_cast<ModelAPI_Feature>(*aFIter);
116 if (aF && aF->data().get() && aF->getKind() == "Extrusion") {
117 AttributeSelectionListPtr aBase = aF->selectionList("base");
119 for(int a = aBase->size() - 1; a >= 0; a--) {
120 ResultPtr aSketchRes = aBase->value(a)->context();
122 static Events_ID HIDE_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TOHIDE);
123 ModelAPI_EventCreator::get()->sendUpdated(aSketchRes, HIDE_DISP);
133 return; // nothing to do: it is executed now
135 //Events_LongOp::start(this);
137 // iterate all documents: features in Root first, then - subs
138 updateInDoc(ModelAPI_Session::get()->moduleDocument());
141 // flush to update display
142 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
143 aLoop->flush(EVENT_DISP);
144 //Events_LongOp::end(this);
145 if (isAutomaticChanged) myIsAutomatic = false;
147 if (theMessage->eventID() == kOpFinishEvent || theMessage->eventID() == kOpAbortEvent) {
148 myJustCreatedOrUpdated.clear();
152 myIsExecuted = false;
155 void Model_Update::updateInDoc(std::shared_ptr<ModelAPI_Document> theDoc)
157 // all features one by one
158 int aNbFeatures = theDoc->size(ModelAPI_Feature::group(), true);
159 for (int aFIndex = 0; aFIndex < aNbFeatures; aFIndex++) {
160 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
161 theDoc->object(ModelAPI_Feature::group(), aFIndex, true));
163 updateFeature(aFeature);
165 // all sub-documents one by one
166 std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(theDoc);
168 const std::set<std::string> aSubs = aDoc->subDocuments(true);
169 for(std::set<std::string>::iterator aSub = aSubs.begin(); aSub != aSubs.end(); aSub++) {
170 DocumentPtr aSubDoc = theDoc->subDocument(*aSub);
172 updateInDoc(aSubDoc);
178 void Model_Update::redisplayWithResults(FeaturePtr theFeature, const ModelAPI_ExecState theState)
180 // make updated and redisplay all results
181 static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
182 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
183 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
184 for (; aRIter != aResults.cend(); aRIter++) {
185 std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
186 aRes->data()->execState(theState);
187 myUpdated[aRes] = true;
188 ModelAPI_EventCreator::get()->sendUpdated(aRes, EVENT_DISP);
190 // to redisplay "presentable" feature (for ex. distance constraint)
191 ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
192 theFeature->data()->execState(theState);
195 /// Updates the state by the referenced object: if something bad with it, set state for this one
196 ModelAPI_ExecState stateByReference(ObjectPtr theTarget, const ModelAPI_ExecState theCurrent)
199 ModelAPI_ExecState aRefState = theTarget->data()->execState();
200 if (aRefState == ModelAPI_StateMustBeUpdated) {
201 return ModelAPI_StateMustBeUpdated;
202 } else if (aRefState != ModelAPI_StateDone) {
203 return ModelAPI_StateInvalidArgument;
209 bool Model_Update::updateFeature(FeaturePtr theFeature)
211 // check it is already processed
212 if (myUpdated.find(theFeature) != myUpdated.end())
213 return myUpdated[theFeature];
214 // check all features this feature depended on (recursive call of updateFeature)
215 ModelAPI_ValidatorsFactory* aFactory = ModelAPI_Session::get()->validators();
216 bool aMustbeUpdated = myInitial.find(theFeature) != myInitial.end();
217 if (theFeature) { // only real feature contains references to other objects
218 if (theFeature->data()->execState() != ModelAPI_StateDone)
219 aMustbeUpdated = true;
221 ModelAPI_ExecState aState = ModelAPI_StateDone;
223 // check the parameters: values can be changed
224 std::list<AttributePtr> aDoubles =
225 theFeature->data()->attributes(ModelAPI_AttributeDouble::typeId());
226 std::list<AttributePtr>::iterator aDoubleIter = aDoubles.begin();
227 for(; aDoubleIter != aDoubles.end(); aDoubleIter++) {
228 AttributeDoublePtr aDouble =
229 std::dynamic_pointer_cast<ModelAPI_AttributeDouble>(*aDoubleIter);
230 if (aDouble.get() && !aDouble->text().empty()) {
232 if (ModelAPI_Tools::findVariable(aDouble->text(), aNewVal)) {
233 if (aNewVal != aDouble->value()) {
234 aDouble->setValue(aNewVal);
235 aMustbeUpdated = true;
238 aState = ModelAPI_StateInvalidArgument;
243 // composite feature must be executed after sub-features execution
244 CompositeFeaturePtr aComposite =
245 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
247 // number of subs can be changed in execution: like fillet
248 for(int a = 0; a < aComposite->numberOfSubs(); a++) {
249 if (updateFeature(aComposite->subFeature(a)))
250 aMustbeUpdated = true;
253 // check all references: if referenced objects are updated, this object also must be updated
254 // also check state of referenced objects: if they are not ready, inherit corresponding state
255 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
256 std::shared_ptr<Model_Data> aData =
257 std::dynamic_pointer_cast<Model_Data>(theFeature->data());
258 aData->referencesToObjects(aRefs);
259 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRef = aRefs.begin();
260 for(; aRef != aRefs.end(); aRef++) {
261 std::list<ObjectPtr>::iterator aRefObj = aRef->second.begin();
262 for(; aRefObj != aRef->second.end(); aRefObj++) {
263 if (updateObject(*aRefObj)) {
264 aMustbeUpdated = true;
266 aState = stateByReference(*aRefObj, aState);
270 //std::cout<<"Update feature "<<theFeature->getKind()<<" must be updated = "<<aMustbeUpdated<<std::endl;
271 // execute feature if it must be updated
272 if (aMustbeUpdated) {
273 if (std::dynamic_pointer_cast<Model_Document>(theFeature->document())->executeFeatures() ||
274 !theFeature->isPersistentResult()) {
275 if (aFactory->validate(theFeature)) {
277 (myJustCreatedOrUpdated.find(theFeature) != myJustCreatedOrUpdated.end()) ||
278 !theFeature->isPersistentResult() /* execute quick, not persistent results */)
280 if (aState == ModelAPI_StateDone) {// all referenced objects are ready to be used
281 //std::cout<<"Execute feature "<<theFeature->getKind()<<std::endl;
282 // before execution update the selection attributes if any
283 list<AttributePtr> aRefs =
284 theFeature->data()->attributes(ModelAPI_AttributeSelection::typeId());
285 list<AttributePtr>::iterator aRefsIter = aRefs.begin();
286 for (; aRefsIter != aRefs.end(); aRefsIter++) {
287 std::shared_ptr<ModelAPI_AttributeSelection> aSel =
288 std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(*aRefsIter);
289 if (!aSel->update()) { // this must be done on execution since it may be long operation
290 if (!aFactory->isNotObligatory(theFeature->getKind(), theFeature->data()->id(aSel)) &&
291 aFactory->isCase(theFeature, theFeature->data()->id(aSel)))
292 aState = ModelAPI_StateInvalidArgument;
295 aRefs = theFeature->data()->attributes(ModelAPI_AttributeSelectionList::typeId());
296 for (aRefsIter = aRefs.begin(); aRefsIter != aRefs.end(); aRefsIter++) {
297 std::shared_ptr<ModelAPI_AttributeSelectionList> aSel =
298 std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(*aRefsIter);
299 for(int a = aSel->size() - 1; a >= 0; a--) {
300 std::shared_ptr<ModelAPI_AttributeSelection> aSelAttr =
301 std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(aSel->value(a));
303 if (!aSelAttr->update()) {
304 if (!aFactory->isNotObligatory(
305 theFeature->getKind(), theFeature->data()->id(aSel)) &&
306 aFactory->isCase(theFeature, theFeature->data()->id(aSel)))
307 aState = ModelAPI_StateInvalidArgument;
312 // for sketch after update of plane (by update of selection attribute)
313 // but before execute, all sub-elements also must be updated (due to the plane changes)
315 // number of subs can be changed in execution: like fillet
316 for(int a = 0; a < aComposite->numberOfSubs(); a++) {
317 FeaturePtr aSub = aComposite->subFeature(a);
318 bool aWasModified = myUpdated[aSub];
319 myUpdated.erase(myUpdated.find(aSub)); // erase to update for sure (plane may be changed)
320 myInitial.insert(aSub);
322 myUpdated[aSub] = aWasModified; // restore value
324 // re-execute after update: solver may update the previous values, so, shapes must be
326 for(int a = 0; a < aComposite->numberOfSubs(); a++) {
327 if (aComposite->subFeature(a) && aFactory->validate(aComposite->subFeature(a)))
328 aComposite->subFeature(a)->execute();
333 // execute in try-catch to avoid internal problems of the feature
334 if (aState == ModelAPI_StateDone) {
335 theFeature->data()->execState(ModelAPI_StateDone);
337 theFeature->execute();
338 if (theFeature->data()->execState() != ModelAPI_StateDone) {
339 aState = ModelAPI_StateExecFailed;
342 aState = ModelAPI_StateExecFailed;
344 "Feature " + theFeature->getKind() + " has failed during the execution");
347 if (aState != ModelAPI_StateDone) {
348 theFeature->eraseResults();
350 redisplayWithResults(theFeature, aState);
351 } else { // must be updatet, but not updated yet
352 theFeature->data()->execState(ModelAPI_StateMustBeUpdated);
353 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
354 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
355 for (; aRIter != aResults.cend(); aRIter++) {
356 std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
357 aRes->data()->execState(ModelAPI_StateMustBeUpdated);
361 theFeature->eraseResults();
362 redisplayWithResults(theFeature, ModelAPI_StateInvalidArgument); // result also must be updated
364 } else { // for automatically updated features (on abort, etc) it is necessary to redisplay anyway
365 redisplayWithResults(theFeature, ModelAPI_StateNothing);
368 // returns also true is results were updated: for sketch that
369 // refers to sub-features but results of sub-features were changed
370 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
371 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
372 for (; aRIter != aResults.cend(); aRIter++) {
373 if (myInitial.find(*aRIter) != myInitial.end()) {
374 aMustbeUpdated = true;
380 myUpdated[theFeature] = aMustbeUpdated;
381 return aMustbeUpdated;
384 bool Model_Update::updateObject(std::shared_ptr<ModelAPI_Object> theObject, const bool theCyclic)
386 if (myUpdated.find(theObject) != myUpdated.end())
387 return myUpdated[theObject]; // already processed
390 if (theCyclic) { // algorithm for update of all features by dependencies tree
393 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
394 if (aFeature) { // for feature just call update Feature
395 return updateFeature(aFeature);
397 // check general object, possible just a result
398 if (myUpdated.find(theObject) != myUpdated.end())
399 return myUpdated[theObject]; // already processed
400 // check the feature of this object must be executed
401 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
403 FeaturePtr aResFeature = aResult->document()->feature(aResult);
405 return updateFeature(aResFeature);
410 return myInitial.find(theObject) != myInitial.end();