1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Objects.cxx
4 // Created: 15 May 2015
5 // Author: Mikhail PONIKAROV
7 #include <Model_Objects.h>
8 #include <Model_Data.h>
9 #include <Model_Document.h>
10 #include <Model_Events.h>
11 #include <Model_Session.h>
12 #include <Model_ResultPart.h>
13 #include <Model_ResultConstruction.h>
14 #include <Model_ResultBody.h>
15 #include <Model_ResultGroup.h>
16 #include <Model_ResultParameter.h>
17 #include <ModelAPI_Validator.h>
18 #include <ModelAPI_CompositeFeature.h>
20 #include <Events_Loop.h>
21 #include <Events_Error.h>
23 #include <TDataStd_Integer.hxx>
24 #include <TDataStd_Comment.hxx>
25 #include <TDF_ChildIDIterator.hxx>
26 #include <TDataStd_ReferenceArray.hxx>
27 #include <TDataStd_HLabelArray1.hxx>
28 #include <TDataStd_Name.hxx>
29 #include <TDF_Reference.hxx>
30 #include <TDF_ChildIDIterator.hxx>
31 #include <TDF_LabelMapHasher.hxx>
33 static const int TAG_OBJECTS = 2; // tag of the objects sub-tree (features, results)
36 static const int TAG_FEATURE_ARGUMENTS = 1; ///< where the arguments are located
37 static const int TAG_FEATURE_RESULTS = 2; ///< where the results are located
40 /// 0:1:2 - where features are located
41 /// 0:1:2:N:1 - data of the feature N
42 /// 0:1:2:N:2:K:1 - data of the K result of the feature N
44 Model_Objects::Model_Objects(TDF_Label theMainLab) : myMain(theMainLab)
48 void Model_Objects::setOwner(DocumentPtr theDoc)
51 // update all fields and recreate features and result objects if needed
52 synchronizeFeatures(false, true, true);
56 Model_Objects::~Model_Objects()
58 // delete all features of this document
59 Events_Loop* aLoop = Events_Loop::loop();
60 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeaturesIter(myFeatures);
61 for(; aFeaturesIter.More(); aFeaturesIter.Next()) {
62 FeaturePtr aFeature = aFeaturesIter.Value();
63 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
64 ModelAPI_EventCreator::get()->sendDeleted(myDoc, ModelAPI_Feature::group());
65 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
66 aFeature->eraseResults();
70 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
71 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
75 /// Appends to the array of references a new referenced label
76 static void AddToRefArray(TDF_Label& theArrayLab, TDF_Label& theReferenced, TDF_Label& thePrevLab)
78 Handle(TDataStd_ReferenceArray) aRefs;
79 if (!theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
80 aRefs = TDataStd_ReferenceArray::Set(theArrayLab, 0, 0);
81 aRefs->SetValue(0, theReferenced);
82 } else { // extend array by one more element
83 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
85 int aPassedPrev = 0; // prev feature is found and passed
86 if (thePrevLab.IsNull()) { // null means that inserted feature must be the first
87 aNewArray->SetValue(aRefs->Lower(), theReferenced);
90 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
91 aNewArray->SetValue(a + aPassedPrev, aRefs->Value(a));
92 if (!aPassedPrev && aRefs->Value(a).IsEqual(thePrevLab)) {
94 aNewArray->SetValue(a + 1, theReferenced);
97 if (!aPassedPrev) // not found: unknown situation
98 aNewArray->SetValue(aRefs->Upper() + 1, theReferenced);
99 aRefs->SetInternalArray(aNewArray);
103 void Model_Objects::addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis)
105 if (!theFeature->isAction()) { // do not add action to the data model
106 TDF_Label aFeaturesLab = featuresLabel();
107 TDF_Label aFeatureLab = aFeaturesLab.NewChild();
108 // store feature in the features array: before "initData" because in macro features
109 // in initData it creates new features, appeared later than this
110 TDF_Label aPrevFeateureLab;
111 if (theAfterThis.get()) { // searching for the previous feature label
112 std::shared_ptr<Model_Data> aPrevData =
113 std::dynamic_pointer_cast<Model_Data>(theAfterThis->data());
114 if (aPrevData.get()) {
115 aPrevFeateureLab = aPrevData->label().Father();
118 AddToRefArray(aFeaturesLab, aFeatureLab, aPrevFeateureLab);
120 initData(theFeature, aFeatureLab, TAG_FEATURE_ARGUMENTS);
121 // keep the feature ID to restore document later correctly
122 TDataStd_Comment::Set(aFeatureLab, theFeature->getKind().c_str());
123 myFeatures.Bind(aFeatureLab, theFeature);
124 // event: feature is added
125 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
126 ModelAPI_EventCreator::get()->sendUpdated(theFeature, anEvent);
127 theFeature->setDisabled(false); // by default created feature is enabled
128 updateHistory(ModelAPI_Feature::group());
129 } else { // make feature has not-null data anyway
130 theFeature->setData(Model_Data::invalidData());
131 theFeature->setDoc(myDoc);
135 /// Appends to the array of references a new referenced label.
136 /// If theIndex is not -1, removes element at this index, not theReferenced.
137 /// \returns the index of removed element
138 static int RemoveFromRefArray(TDF_Label theArrayLab, TDF_Label theReferenced,
139 const int theIndex = -1)
141 int aResult = -1; // no returned
142 Handle(TDataStd_ReferenceArray) aRefs;
143 if (theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
144 if (aRefs->Length() == 1) { // just erase an array
145 if ((theIndex == -1 && aRefs->Value(0) == theReferenced) || theIndex == 0) {
146 theArrayLab.ForgetAttribute(TDataStd_ReferenceArray::GetID());
149 } else { // reduce the array
150 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
152 int aCount = aRefs->Lower();
153 for (int a = aCount; a <= aRefs->Upper(); a++, aCount++) {
154 if ((theIndex == -1 && aRefs->Value(a) == theReferenced) || theIndex == a) {
158 aNewArray->SetValue(aCount, aRefs->Value(a));
161 aRefs->SetInternalArray(aNewArray);
167 void Model_Objects::refsToFeature(FeaturePtr theFeature,
168 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
170 // check the feature: it must have no depended objects on it
171 // the dependencies can be in the feature results
172 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
173 for(; aResIter != theFeature->results().cend(); aResIter++) {
174 ResultPtr aResult = (*aResIter);
175 std::shared_ptr<Model_Data> aData =
176 std::dynamic_pointer_cast<Model_Data>(aResult->data());
177 if (aData.get() != NULL) {
178 const std::set<AttributePtr>& aRefs = aData->refsToMe();
179 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
180 for(; aRefIt != aRefLast; aRefIt++) {
181 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
182 if (aFeature.get() != NULL)
183 theRefs.insert(aFeature);
187 // the dependencies can be in the feature itself
188 std::shared_ptr<Model_Data> aData =
189 std::dynamic_pointer_cast<Model_Data>(theFeature->data());
190 if (aData && !aData->refsToMe().empty()) {
191 const std::set<AttributePtr>& aRefs = aData->refsToMe();
192 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
193 for(; aRefIt != aRefLast; aRefIt++) {
194 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
195 if (aFeature.get() != NULL)
196 theRefs.insert(aFeature);
200 if (!theRefs.empty() && isSendError) {
202 "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
206 void Model_Objects::removeFeature(FeaturePtr theFeature)
208 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theFeature->data());
209 if (aData && aData->isValid()) {
210 // checking that the sub-element of composite feature is removed: if yes, inform the owner
211 std::set<std::shared_ptr<ModelAPI_Feature> > aRefs;
212 refsToFeature(theFeature, aRefs, false);
213 std::set<std::shared_ptr<ModelAPI_Feature> >::iterator aRefIter = aRefs.begin();
214 for(; aRefIter != aRefs.end(); aRefIter++) {
215 std::shared_ptr<ModelAPI_CompositeFeature> aComposite =
216 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*aRefIter);
217 if (aComposite.get()) {
218 aComposite->removeFeature(theFeature);
221 // this must be before erase since theFeature erasing removes all information about
222 // the feature results and groups of results
223 // To reproduce: create sketch, extrusion, remove sketch => constructions tree is not updated
224 clearHistory(theFeature);
228 TDF_Label aFeatureLabel = aData->label().Father();
229 if (myFeatures.IsBound(aFeatureLabel))
230 myFeatures.UnBind(aFeatureLabel);
232 static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
233 ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
234 // erase all attributes under the label of feature
235 aFeatureLabel.ForgetAllAttributes();
236 // remove it from the references array
237 RemoveFromRefArray(featuresLabel(), aFeatureLabel);
238 // event: feature is deleted
239 ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
240 // the redisplay signal should be flushed in order to erase the feature presentation in the viewer
241 Events_Loop::loop()->flush(EVENT_DISP);
242 updateHistory(ModelAPI_Feature::group());
246 void Model_Objects::clearHistory(ObjectPtr theObj)
249 const std::string aGroup = theObj->groupName();
250 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(aGroup);
251 if (aHIter != myHistory.end())
252 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
253 if (theObj->groupName() == ModelAPI_Feature::group()) { // clear results group of the feature
254 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
255 std::string aResultGroup = featureResultGroup(aFeature);
256 if (!aResultGroup.empty()) {
257 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter =
258 myHistory.find(aResultGroup);
259 if (aHIter != myHistory.end())
260 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
266 void Model_Objects::createHistory(const std::string& theGroupID)
268 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(theGroupID);
269 if (aHIter == myHistory.end()) {
270 myHistory[theGroupID] = std::vector<ObjectPtr>();
271 std::vector<ObjectPtr>& aResult = myHistory[theGroupID];
272 // iterate the array of references and get feature by feature from the array
273 bool isFeature = theGroupID == ModelAPI_Feature::group();
274 Handle(TDataStd_ReferenceArray) aRefs;
275 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
276 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
277 FeaturePtr aFeature = feature(aRefs->Value(a));
278 if (aFeature.get()) {
279 if (isFeature) { // here may be also disabled features
280 if (aFeature->isInHistory()) {
281 aResult.push_back(aFeature);
283 } else if (!aFeature->isDisabled()) { // iterate all results of not-disabled feature
284 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
285 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
286 for (; aRIter != aResults.cend(); aRIter++) {
287 ResultPtr aRes = *aRIter;
288 if (aRes->groupName() != theGroupID) break; // feature have only same group results
289 if (!aRes->isDisabled() && aRes->isInHistory() && !aRes->isConcealed()) {
290 aResult.push_back(*aRIter);
300 void Model_Objects::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
302 clearHistory(theObject);
305 void Model_Objects::updateHistory(const std::string theGroup)
307 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(theGroup);
308 if (aHIter != myHistory.end())
309 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
312 FeaturePtr Model_Objects::feature(TDF_Label theLabel) const
314 if (myFeatures.IsBound(theLabel))
315 return myFeatures.Find(theLabel);
316 return FeaturePtr(); // not found
319 ObjectPtr Model_Objects::object(TDF_Label theLabel)
321 // try feature by label
322 FeaturePtr aFeature = feature(theLabel);
324 return feature(theLabel);
325 TDF_Label aFeatureLabel = theLabel.Father().Father(); // let's suppose it is result
326 aFeature = feature(aFeatureLabel);
328 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
329 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
330 for (; aRIter != aResults.cend(); aRIter++) {
331 std::shared_ptr<Model_Data> aResData = std::dynamic_pointer_cast<Model_Data>(
333 if (aResData->label().Father().IsEqual(theLabel))
337 return FeaturePtr(); // not found
340 ObjectPtr Model_Objects::object(const std::string& theGroupID, const int theIndex)
342 createHistory(theGroupID);
343 //TODO: mpv stabilization hotfix
344 if (myHistory[theGroupID].size() <= (const unsigned int)theIndex)
346 return myHistory[theGroupID][theIndex];
349 std::shared_ptr<ModelAPI_Object> Model_Objects::objectByName(
350 const std::string& theGroupID, const std::string& theName)
352 createHistory(theGroupID);
353 std::vector<ObjectPtr>& allObjs = myHistory[theGroupID];
354 std::vector<ObjectPtr>::iterator anObjIter = allObjs.begin();
355 for(; anObjIter != allObjs.end(); anObjIter++) {
356 if ((*anObjIter)->data()->name() == theName)
363 const int Model_Objects::index(std::shared_ptr<ModelAPI_Object> theObject)
365 std::string aGroup = theObject->groupName();
366 createHistory(aGroup);
367 std::vector<ObjectPtr>& allObjs = myHistory[aGroup];
368 std::vector<ObjectPtr>::iterator anObjIter = allObjs.begin(); // iterate to search object
369 for(int anIndex = 0; anObjIter != allObjs.end(); anObjIter++, anIndex++) {
370 if ((*anObjIter) == theObject)
377 int Model_Objects::size(const std::string& theGroupID)
379 createHistory(theGroupID);
380 return myHistory[theGroupID].size();
383 void Model_Objects::allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults)
385 // iterate the array of references and get feature by feature from the array
386 Handle(TDataStd_ReferenceArray) aRefs;
387 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
388 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
389 FeaturePtr aFeature = feature(aRefs->Value(a));
390 if (aFeature.get()) {
391 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
392 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
393 for (; aRIter != aResults.cend(); aRIter++) {
394 ResultPtr aRes = *aRIter;
395 if (aRes->groupName() != theGroupID) break; // feature have only same group results
396 if (aRes->isInHistory() && !aRes->isConcealed()) {
397 theResults.push_back(*aRIter);
406 TDF_Label Model_Objects::featuresLabel() const
408 return myMain.FindChild(TAG_OBJECTS);
411 void Model_Objects::setUniqueName(FeaturePtr theFeature)
413 if (!theFeature->data()->name().empty())
414 return; // not needed, name is already defined
415 std::string aName; // result
416 // first count all features of such kind to start with index = count + 1
418 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myFeatures);
419 for (; aFIter.More(); aFIter.Next()) {
420 if (aFIter.Value()->getKind() == theFeature->getKind())
423 // generate candidate name
424 std::stringstream aNameStream;
425 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
426 aName = aNameStream.str();
427 // check this is unique, if not, increase index by 1
428 for (aFIter.Initialize(myFeatures); aFIter.More();) {
429 FeaturePtr aFeature = aFIter.Value();
430 bool isSameName = aFeature->data()->name() == aName;
431 if (!isSameName) { // check also results to avoid same results names (actual for Parts)
432 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
433 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
434 for (; aRIter != aResults.cend(); aRIter++) {
435 isSameName = (*aRIter)->data()->name() == aName;
440 std::stringstream aNameStream;
441 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
442 aName = aNameStream.str();
443 // reinitialize iterator to make sure a new name is unique
444 aFIter.Initialize(myFeatures);
448 theFeature->data()->setName(aName);
451 void Model_Objects::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
453 std::shared_ptr<Model_Data> aData(new Model_Data);
454 aData->setLabel(theLab.FindChild(theTag));
455 aData->setObject(theObj);
456 theObj->setDoc(myDoc);
457 theObj->setData(aData);
458 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
460 setUniqueName(aFeature); // must be before "initAttributes" because duplicate part uses name
462 theObj->initAttributes();
465 void Model_Objects::synchronizeFeatures(
466 const bool theMarkUpdated, const bool theUpdateReferences, const bool theFlush)
468 Model_Document* anOwner = std::dynamic_pointer_cast<Model_Document>(myDoc).get();
469 if (!anOwner) // this may happen on creation of document: nothing there, so nothing to synchronize
471 // after all updates, sends a message that groups of features were created or updated
472 Events_Loop* aLoop = Events_Loop::loop();
473 static Events_ID aDispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
474 static Events_ID aCreateEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
475 static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
476 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
477 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
478 static Events_ID aToHideEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
479 bool isActive = aLoop->activateFlushes(false);
481 // update all objects by checking are they on labels or not
482 std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
483 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
484 for (; aLabIter.More(); aLabIter.Next()) {
485 TDF_Label aFeatureLabel = aLabIter.Value()->Label();
487 if (!myFeatures.IsBound(aFeatureLabel)) { // a new feature is inserted
489 aFeature = std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get())->createFeature(
490 TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
491 .ToCString(), anOwner);
492 if (!aFeature) { // somethig is wrong, most probably, the opened document has invalid structure
493 Events_Error::send("Invalid type of object in the document");
494 aLabIter.Value()->Label().ForgetAllAttributes();
497 // this must be before "setData" to redo the sketch line correctly
498 myFeatures.Bind(aFeatureLabel, aFeature);
499 aNewFeatures.insert(aFeature);
500 initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
501 updateHistory(aFeature);
502 aFeature->setDisabled(false); // by default created feature is enabled (this allows to recreate the results before "setCurrent" is called)
504 // event: model is updated
505 ModelAPI_EventCreator::get()->sendUpdated(aFeature, aCreateEvent);
506 } else { // nothing is changed, both iterators are incremented
507 aFeature = myFeatures.Find(aFeatureLabel);
508 aKeptFeatures.insert(aFeature);
509 if (theMarkUpdated) {
510 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anUpdateEvent);
514 // update results of the features (after features created because they may be connected, like sketch and sub elements)
515 std::list<FeaturePtr> aComposites; // composites must be updated after their subs (issue 360)
516 TDF_ChildIDIterator aLabIter2(featuresLabel(), TDataStd_Comment::GetID());
517 for (; aLabIter2.More(); aLabIter2.Next()) {
518 TDF_Label aFeatureLabel = aLabIter2.Value()->Label();
519 if (myFeatures.IsBound(aFeatureLabel)) { // a new feature is inserted
520 FeaturePtr aFeature = myFeatures.Find(aFeatureLabel);
521 if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature).get())
522 aComposites.push_back(aFeature);
523 updateResults(aFeature);
526 std::list<FeaturePtr>::iterator aComposite = aComposites.begin();
527 for(; aComposite != aComposites.end(); aComposite++) {
528 updateResults(*aComposite);
531 // check all features are checked: if not => it was removed
532 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myFeatures);
533 while (aFIter.More()) {
534 if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
535 && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
536 FeaturePtr aFeature = aFIter.Value();
537 // event: model is updated
538 //if (aFeature->isInHistory()) {
539 ModelAPI_EventCreator::get()->sendDeleted(myDoc, ModelAPI_Feature::group());
541 // results of this feature must be redisplayed (hided)
542 // redisplay also removed feature (used for sketch and AISObject)
543 ModelAPI_EventCreator::get()->sendUpdated(aFeature, aRedispEvent);
544 updateHistory(aFeature);
546 // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
547 myFeatures.UnBind(aFIter.Key());
548 // reinitialize iterator because unbind may corrupt the previous order in the map
549 aFIter.Initialize(myFeatures);
554 if (theUpdateReferences) {
555 synchronizeBackRefs();
557 if (theMarkUpdated) { // this means there is no control what was modified => remove history cash
561 anOwner->executeFeatures() = false;
562 aLoop->activateFlushes(isActive);
565 aLoop->flush(aCreateEvent);
566 aLoop->flush(aDeleteEvent);
567 aLoop->flush(anUpdateEvent);
568 aLoop->flush(aRedispEvent);
569 aLoop->flush(aToHideEvent);
571 anOwner->executeFeatures() = true;
574 void Model_Objects::synchronizeBackRefs()
576 // keeps the concealed flags of result to catch the change and create created/deleted events
577 std::list<std::pair<ResultPtr, bool> > aConcealed;
578 // first cycle: erase all data about back-references
579 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myFeatures);
580 for(; aFeatures.More(); aFeatures.Next()) {
581 FeaturePtr aFeature = aFeatures.Value();
582 std::shared_ptr<Model_Data> aFData =
583 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
585 aFData->eraseBackReferences();
587 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
588 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
589 for (; aRIter != aResults.cend(); aRIter++) {
590 std::shared_ptr<Model_Data> aResData =
591 std::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
593 aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
594 aResData->eraseBackReferences();
599 // second cycle: set new back-references: only features may have reference, iterate only them
600 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
601 for(aFeatures.Initialize(myFeatures); aFeatures.More(); aFeatures.Next()) {
602 FeaturePtr aFeature = aFeatures.Value();
603 std::shared_ptr<Model_Data> aFData =
604 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
606 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
607 aFData->referencesToObjects(aRefs);
608 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator
609 aRefsIter = aRefs.begin();
610 for(; aRefsIter != aRefs.end(); aRefsIter++) {
611 std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
612 for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
614 std::shared_ptr<Model_Data> aRefData =
615 std::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
616 aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
617 // update enable/disable status: the nested status must be equal to the composite
618 CompositeFeaturePtr aComp =
619 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
621 FeaturePtr aReferenced = std::dynamic_pointer_cast<ModelAPI_Feature>(*aRefTo);
622 if (aReferenced.get()) {
623 aReferenced->setDisabled(aComp->isDisabled());
631 std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
632 for(; aCIter != aConcealed.end(); aCIter++) {
633 if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
634 if (aCIter->second) { // was concealed become not => creation event
635 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
636 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
637 } else { // was not concealed become concealed => delete event
638 ModelAPI_EventCreator::get()->sendDeleted(myDoc, aCIter->first->groupName());
639 // redisplay for the viewer (it must be disappeared also)
640 static Events_ID EVENT_DISP =
641 Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
642 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, EVENT_DISP);
648 TDF_Label Model_Objects::resultLabel(
649 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex)
651 const std::shared_ptr<Model_Data>& aData =
652 std::dynamic_pointer_cast<Model_Data>(theFeatureData);
653 return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
656 void Model_Objects::storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
657 std::shared_ptr<ModelAPI_Result> theResult,
658 const int theResultIndex)
660 theResult->setDoc(myDoc);
661 initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
662 if (theResult->data()->name().empty()) { // if was not initialized, generate event and set a name
663 std::stringstream aNewName;
664 aNewName<<theFeatureData->name();
665 if (theResultIndex > 0) // if there are several results, add unique prefix starting from second
666 aNewName<<"_"<<theResultIndex + 1;
667 theResult->data()->setName(aNewName.str());
671 std::shared_ptr<ModelAPI_ResultConstruction> Model_Objects::createConstruction(
672 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
674 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
675 TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
676 ObjectPtr anOldObject = object(aLab);
677 std::shared_ptr<ModelAPI_ResultConstruction> aResult;
679 aResult = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
682 aResult = std::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
683 storeResult(theFeatureData, aResult, theIndex);
688 std::shared_ptr<ModelAPI_ResultBody> Model_Objects::createBody(
689 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
691 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
692 TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
693 ObjectPtr anOldObject = object(aLab);
694 std::shared_ptr<ModelAPI_ResultBody> aResult;
696 aResult = std::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
699 aResult = std::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
700 storeResult(theFeatureData, aResult, theIndex);
705 std::shared_ptr<ModelAPI_ResultPart> Model_Objects::createPart(
706 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
708 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
709 TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
710 ObjectPtr anOldObject = object(aLab);
711 std::shared_ptr<ModelAPI_ResultPart> aResult;
713 aResult = std::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
716 aResult = std::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
717 storeResult(theFeatureData, aResult, theIndex);
722 std::shared_ptr<ModelAPI_ResultGroup> Model_Objects::createGroup(
723 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
725 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
726 TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
727 ObjectPtr anOldObject = object(aLab);
728 std::shared_ptr<ModelAPI_ResultGroup> aResult;
730 aResult = std::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
733 aResult = std::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
734 storeResult(theFeatureData, aResult, theIndex);
739 std::shared_ptr<ModelAPI_ResultParameter> Model_Objects::createParameter(
740 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
742 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
743 TDataStd_Comment::Set(aLab, ModelAPI_ResultParameter::group().c_str());
744 ObjectPtr anOldObject = object(aLab);
745 std::shared_ptr<ModelAPI_ResultParameter> aResult;
747 aResult = std::dynamic_pointer_cast<ModelAPI_ResultParameter>(anOldObject);
750 aResult = std::shared_ptr<ModelAPI_ResultParameter>(new Model_ResultParameter);
751 storeResult(theFeatureData, aResult, theIndex);
756 std::shared_ptr<ModelAPI_Feature> Model_Objects::feature(
757 const std::shared_ptr<ModelAPI_Result>& theResult)
759 std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
761 TDF_Label aFeatureLab = aData->label().Father().Father().Father();
762 return feature(aFeatureLab);
767 std::string Model_Objects::featureResultGroup(FeaturePtr theFeature)
769 if (theFeature->data()->isValid()) {
770 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
771 if (aLabIter.More()) {
772 TDF_Label anArgLab = aLabIter.Value();
773 Handle(TDataStd_Comment) aGroup;
774 if (aLabIter.Value().FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
775 return TCollection_AsciiString(aGroup->Get()).ToCString();
779 static std::string anEmpty;
780 return anEmpty; // not found
783 void Model_Objects::updateResults(FeaturePtr theFeature)
785 // for not persistent is will be done by parametric updater automatically
786 //if (!theFeature->isPersistentResult()) return;
787 // check the existing results and remove them if there is nothing on the label
788 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
789 while(aResIter != theFeature->results().cend()) {
790 ResultPtr aBody = std::dynamic_pointer_cast<ModelAPI_Result>(*aResIter);
792 if (!aBody->data()->isValid()) {
793 // found a disappeared result => remove it
794 theFeature->eraseResultFromList(aBody);
795 // start iterate from beginning because iterator is corrupted by removing
796 aResIter = theFeature->results().cbegin();
803 if (!theFeature->data() || !theFeature->data()->isValid() || theFeature->isDisabled())
805 // check that results are presented on all labels
806 int aResSize = theFeature->results().size();
807 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
808 for(; aLabIter.More(); aLabIter.Next()) {
809 // here must be GUID of the feature
810 int aResIndex = aLabIter.Value().Tag() - 1;
812 if (aResSize <= aResIndex) {
813 TDF_Label anArgLab = aLabIter.Value();
814 Handle(TDataStd_Comment) aGroup;
815 if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
816 if (aGroup->Get() == ModelAPI_ResultBody::group().c_str()) {
817 aNewBody = createBody(theFeature->data(), aResIndex);
818 } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
819 std::shared_ptr<ModelAPI_ResultPart> aNewP = createPart(theFeature->data(), aResIndex);
820 theFeature->setResult(aNewP, aResIndex);
821 if (!aNewP->partDoc().get())
822 theFeature->execute(); // create the part result: it is better to restore the previous result if it is possible
824 } else if (aGroup->Get() == ModelAPI_ResultConstruction::group().c_str()) {
825 theFeature->execute(); // construction shapes are needed for sketch solver
827 } else if (aGroup->Get() == ModelAPI_ResultGroup::group().c_str()) {
828 aNewBody = createGroup(theFeature->data(), aResIndex);
829 } else if (aGroup->Get() == ModelAPI_ResultParameter::group().c_str()) {
830 theFeature->attributeChanged("expression"); // just produce a value
833 Events_Error::send(std::string("Unknown type of result is found in the document:") +
834 TCollection_AsciiString(aGroup->Get()).ToCString());
838 theFeature->setResult(aNewBody, aResIndex);
844 ResultPtr Model_Objects::findByName(const std::string theName)
846 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator anObjIter(myFeatures);
847 for(; anObjIter.More(); anObjIter.Next()) {
848 FeaturePtr& aFeature = anObjIter.ChangeValue();
849 if (!aFeature.get() || aFeature->isDisabled()) // may be on close
851 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
852 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
853 for (; aRIter != aResults.cend(); aRIter++) {
854 ResultPtr aRes = *aRIter;
855 if (aRes.get() && aRes->data() && aRes->data()->isValid() && !aRes->isDisabled() &&
856 aRes->data()->name() == theName) {
865 FeaturePtr Model_Objects::nextFeature(FeaturePtr theCurrent, const bool theReverse)
867 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
868 if (aData && aData->isValid()) {
869 TDF_Label aFeatureLabel = aData->label().Father();
870 Handle(TDataStd_ReferenceArray) aRefs;
871 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
872 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) { // iterate all existing features
873 if (aRefs->Value(a).IsEqual(aFeatureLabel)) {
874 a += theReverse ? -1 : 1;
875 if (a >= aRefs->Lower() && a <= aRefs->Upper())
876 return feature(aRefs->Value(a));
877 break; // finish iiteration: it's last feature
882 return FeaturePtr(); // not found, last, or something is wrong
885 FeaturePtr Model_Objects::firstFeature()
887 Handle(TDataStd_ReferenceArray) aRefs;
888 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
889 return feature(aRefs->Value(aRefs->Lower()));
891 return FeaturePtr(); // no features at all
894 FeaturePtr Model_Objects::lastFeature()
896 Handle(TDataStd_ReferenceArray) aRefs;
897 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
898 return feature(aRefs->Value(aRefs->Upper()));
900 return FeaturePtr(); // no features at all
903 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Objects::allFeatures()
905 std::list<std::shared_ptr<ModelAPI_Feature> > aResult;
906 Handle(TDataStd_ReferenceArray) aRefs;
907 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
908 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
909 FeaturePtr aFeature = feature(aRefs->Value(a));
911 aResult.push_back(aFeature);
917 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
919 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
922 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
924 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);