1 // File: Model_Document.cxx
2 // Created: 28 Feb 2014
3 // Author: Mikhail PONIKAROV
5 #include <Model_Document.h>
6 #include <Model_Data.h>
7 #include <Model_Application.h>
8 #include <Model_Session.h>
9 #include <Model_Events.h>
10 #include <Model_ResultPart.h>
11 #include <Model_ResultConstruction.h>
12 #include <Model_ResultBody.h>
13 #include <Model_ResultGroup.h>
14 #include <ModelAPI_Validator.h>
15 #include <Events_Loop.h>
16 #include <Events_Error.h>
18 #include <TDataStd_Integer.hxx>
19 #include <TDataStd_Comment.hxx>
20 #include <TDF_ChildIDIterator.hxx>
21 #include <TDataStd_ReferenceArray.hxx>
22 #include <TDataStd_HLabelArray1.hxx>
23 #include <TDataStd_Name.hxx>
24 #include <TDF_Reference.hxx>
25 #include <TDF_ChildIDIterator.hxx>
26 #include <TDF_LabelMapHasher.hxx>
34 # define _separator_ '\\'
36 # define _separator_ '/'
39 static const int UNDO_LIMIT = 10; // number of possible undo operations
41 static const int TAG_GENERAL = 1; // general properties tag
42 static const int TAG_OBJECTS = 2; // tag of the objects sub-tree (features, results)
43 static const int TAG_HISTORY = 3; // tag of the history sub-tree (python dump)
46 static const int TAG_FEATURE_ARGUMENTS = 1; ///< where the arguments are located
47 static const int TAG_FEATURE_RESULTS = 2; ///< where the results are located
49 Model_Document::Model_Document(const std::string theID, const std::string theKind)
50 : myID(theID), myKind(theKind),
51 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
53 myDoc->SetUndoLimit(UNDO_LIMIT);
54 myTransactionsAfterSave = 0;
56 myExecuteFeatures = true;
57 // to have something in the document and avoid empty doc open/save problem
58 // in transaction for nesting correct working
60 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
61 myDoc->CommitCommand();
64 /// Returns the file name of this document by the nameof directory and identifuer of a document
65 static TCollection_ExtendedString DocFileName(const char* theFileName, const std::string& theID)
67 TCollection_ExtendedString aPath((const Standard_CString) theFileName);
68 // remove end-separators
69 while(aPath.Length() && (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
70 aPath.Remove(aPath.Length());
72 aPath += theID.c_str();
73 aPath += ".cbf"; // standard binary file extension
77 bool Model_Document::load(const char* theFileName)
79 Handle(Model_Application) anApp = Model_Application::getApplication();
80 if (this == Model_Session::get()->moduleDocument().get()) {
81 anApp->setLoadPath(theFileName);
83 TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
84 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
86 aStatus = anApp->Open(aPath, myDoc);
87 } catch (Standard_Failure) {
88 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
90 std::string("Exception in opening of document: ") + aFail->GetMessageString());
93 bool isError = aStatus != PCDM_RS_OK;
96 case PCDM_RS_UnknownDocument:
97 Events_Error::send(std::string("Can not open document: unknown format"));
99 case PCDM_RS_AlreadyRetrieved:
100 Events_Error::send(std::string("Can not open document: already opened"));
102 case PCDM_RS_AlreadyRetrievedAndModified:
104 std::string("Can not open document: already opened and modified"));
106 case PCDM_RS_NoDriver:
107 Events_Error::send(std::string("Can not open document: driver library is not found"));
109 case PCDM_RS_UnknownFileDriver:
110 Events_Error::send(std::string("Can not open document: unknown driver for opening"));
112 case PCDM_RS_OpenError:
113 Events_Error::send(std::string("Can not open document: file open error"));
115 case PCDM_RS_NoVersion:
116 Events_Error::send(std::string("Can not open document: invalid version"));
118 case PCDM_RS_NoModel:
119 Events_Error::send(std::string("Can not open document: no data model"));
121 case PCDM_RS_NoDocument:
122 Events_Error::send(std::string("Can not open document: no document inside"));
124 case PCDM_RS_FormatFailure:
125 Events_Error::send(std::string("Can not open document: format failure"));
127 case PCDM_RS_TypeNotFoundInSchema:
128 Events_Error::send(std::string("Can not open document: invalid object"));
130 case PCDM_RS_UnrecognizedFileFormat:
131 Events_Error::send(std::string("Can not open document: unrecognized file format"));
133 case PCDM_RS_MakeFailure:
134 Events_Error::send(std::string("Can not open document: make failure"));
136 case PCDM_RS_PermissionDenied:
137 Events_Error::send(std::string("Can not open document: permission denied"));
139 case PCDM_RS_DriverFailure:
140 Events_Error::send(std::string("Can not open document: driver failure"));
143 Events_Error::send(std::string("Can not open document: unknown error"));
148 myDoc->SetUndoLimit(UNDO_LIMIT);
149 // to avoid the problem that feature is created in the current, not this, document
150 Model_Session::get()->setActiveDocument(anApp->getDocument(myID), false);
151 synchronizeFeatures(false, true);
152 Model_Session::get()->setActiveDocument(Model_Session::get()->moduleDocument(), false);
153 Model_Session::get()->setActiveDocument(anApp->getDocument(myID), true);
158 bool Model_Document::save(const char* theFileName, std::list<std::string>& theResults)
160 // create a directory in the root document if it is not yet exist
161 if (this == Model_Session::get()->moduleDocument().get()) {
163 CreateDirectory(theFileName, NULL);
165 mkdir(theFileName, 0x1ff);
168 // filename in the dir is id of document inside of the given directory
169 TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
170 PCDM_StoreStatus aStatus;
172 aStatus = Model_Application::getApplication()->SaveAs(myDoc, aPath);
173 } catch (Standard_Failure) {
174 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
176 std::string("Exception in saving of document: ") + aFail->GetMessageString());
179 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
182 case PCDM_SS_DriverFailure:
183 Events_Error::send(std::string("Can not save document: save driver-library failure"));
185 case PCDM_SS_WriteFailure:
186 Events_Error::send(std::string("Can not save document: file writing failure"));
188 case PCDM_SS_Failure:
190 Events_Error::send(std::string("Can not save document"));
194 myTransactionsAfterSave = 0;
195 if (isDone) { // save also sub-documents if any
196 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
197 std::set<std::string>::iterator aSubIter = mySubs.begin();
198 for (; aSubIter != mySubs.end() && isDone; aSubIter++) {
199 isDone = subDoc(*aSubIter)->save(theFileName, theResults);
205 void Model_Document::close()
207 boost::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
208 if (this != aPM->moduleDocument().get() && this == aPM->activeDocument().get()) {
209 aPM->setActiveDocument(aPM->moduleDocument());
212 std::set<std::string>::iterator aSubIter = mySubs.begin();
213 for (; aSubIter != mySubs.end(); aSubIter++)
214 subDoc(*aSubIter)->close();
216 // close this only if it is module document, otherwise it can be undoed
217 if (this == aPM->moduleDocument().get()) {
218 if (myDoc->CanClose() == CDM_CCS_OK)
220 Model_Application::getApplication()->deleteDocument(myID);
224 void Model_Document::startOperation()
226 if (myDoc->HasOpenCommand()) { // start of nested command
227 if (myNestedNum == -1) {
229 myDoc->InitDeltaCompaction();
231 myIsEmptyTr[myTransactionsAfterSave] = !myDoc->CommitCommand();
232 myTransactionsAfterSave++;
233 myDoc->OpenCommand();
234 } else { // start the simple command
237 // new command for all subs
238 std::set<std::string>::iterator aSubIter = mySubs.begin();
239 for (; aSubIter != mySubs.end(); aSubIter++)
240 subDoc(*aSubIter)->startOperation();
243 bool Model_Document::compactNested()
245 bool allWasEmpty = true;
246 while (myNestedNum != -1) {
247 myTransactionsAfterSave--;
248 if (!myIsEmptyTr[myTransactionsAfterSave]) {
251 myIsEmptyTr.erase(myTransactionsAfterSave);
254 myIsEmptyTr[myTransactionsAfterSave] = allWasEmpty;
255 myTransactionsAfterSave++;
257 // if everything is empty, it is a problem for OCCT to work with it,
258 // just commit the empty that returns nothing
259 myDoc->CommitCommand();
261 myDoc->PerformDeltaCompaction();
266 void Model_Document::finishOperation()
268 // just to be sure that everybody knows that changes were performed
269 if (!myDoc->HasOpenCommand() && myNestedNum != -1)
270 boost::static_pointer_cast<Model_Session>(Model_Session::get())
271 ->setCheckTransactions(false); // for nested transaction commit
272 synchronizeBackRefs();
273 Events_Loop* aLoop = Events_Loop::loop();
274 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
275 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
276 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
277 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
278 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
279 // this must be here just after everything is finished but before real transaction stop
280 // to avoid messages about modifications outside of the transaction
281 // and to rebuild everything after all updates and creates
282 if (Model_Session::get()->moduleDocument().get() == this) { // once for root document
283 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
284 static boost::shared_ptr<Events_Message> aFinishMsg
285 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
286 Events_Loop::loop()->send(aFinishMsg);
287 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
289 // to avoid "updated" message appearance by updater
290 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
292 if (!myDoc->HasOpenCommand() && myNestedNum != -1)
293 boost::static_pointer_cast<Model_Session>(Model_Session::get())
294 ->setCheckTransactions(true); // for nested transaction commit
296 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
297 std::set<std::string>::iterator aSubIter = mySubs.begin();
298 for (; aSubIter != mySubs.end(); aSubIter++)
299 subDoc(*aSubIter)->finishOperation();
301 if (myNestedNum != -1) // this nested transaction is owervritten
303 if (!myDoc->HasOpenCommand()) {
304 if (myNestedNum != -1) {
309 // returns false if delta is empty and no transaction was made
310 myIsEmptyTr[myTransactionsAfterSave] = !myDoc->CommitCommand(); // && (myNestedNum == -1);
311 myTransactionsAfterSave++;
315 void Model_Document::abortOperation()
317 if (myNestedNum > 0 && !myDoc->HasOpenCommand()) { // abort all what was done in nested
318 // first compact all nested
319 if (compactNested()) {
320 // for nested it is undo and clear redos
324 myTransactionsAfterSave--;
325 myIsEmptyTr.erase(myTransactionsAfterSave);
327 if (myNestedNum == 0) // abort only high-level
329 myDoc->AbortCommand();
331 synchronizeFeatures(true, false); // references were not changed since transaction start
332 // abort for all subs
333 std::set<std::string>::iterator aSubIter = mySubs.begin();
334 for (; aSubIter != mySubs.end(); aSubIter++)
335 subDoc(*aSubIter)->abortOperation();
338 bool Model_Document::isOperation()
340 // operation is opened for all documents: no need to check subs
341 return myDoc->HasOpenCommand() == Standard_True ;
344 bool Model_Document::isModified()
346 // is modified if at least one operation was commited and not undoed
347 return myTransactionsAfterSave > 0 || isOperation();
350 bool Model_Document::canUndo()
352 if (myDoc->GetAvailableUndos() > 0 && myNestedNum != 0
353 && myTransactionsAfterSave != 0 /* for omitting the first useless transaction */)
355 // check other subs contains operation that can be undoed
356 std::set<std::string>::iterator aSubIter = mySubs.begin();
357 for (; aSubIter != mySubs.end(); aSubIter++)
358 if (subDoc(*aSubIter)->canUndo())
363 void Model_Document::undo()
365 myTransactionsAfterSave--;
368 if (!myIsEmptyTr[myTransactionsAfterSave])
370 synchronizeFeatures(true, true);
372 std::set<std::string>::iterator aSubIter = mySubs.begin();
373 for (; aSubIter != mySubs.end(); aSubIter++)
374 subDoc(*aSubIter)->undo();
377 bool Model_Document::canRedo()
379 if (myDoc->GetAvailableRedos() > 0)
381 // check other subs contains operation that can be redoed
382 std::set<std::string>::iterator aSubIter = mySubs.begin();
383 for (; aSubIter != mySubs.end(); aSubIter++)
384 if (subDoc(*aSubIter)->canRedo())
389 void Model_Document::redo()
391 if (myNestedNum != -1)
393 if (!myIsEmptyTr[myTransactionsAfterSave])
395 myTransactionsAfterSave++;
396 synchronizeFeatures(true, true);
398 std::set<std::string>::iterator aSubIter = mySubs.begin();
399 for (; aSubIter != mySubs.end(); aSubIter++)
400 subDoc(*aSubIter)->redo();
403 /// Appenad to the array of references a new referenced label
404 static void AddToRefArray(TDF_Label& theArrayLab, TDF_Label& theReferenced)
406 Handle(TDataStd_ReferenceArray) aRefs;
407 if (!theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
408 aRefs = TDataStd_ReferenceArray::Set(theArrayLab, 0, 0);
409 aRefs->SetValue(0, theReferenced);
410 } else { // extend array by one more element
411 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
413 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
414 aNewArray->SetValue(a, aRefs->Value(a));
416 aNewArray->SetValue(aRefs->Upper() + 1, theReferenced);
417 aRefs->SetInternalArray(aNewArray);
421 FeaturePtr Model_Document::addFeature(std::string theID)
423 TDF_Label anEmptyLab;
424 FeaturePtr anEmptyFeature;
425 FeaturePtr aFeature = ModelAPI_Session::get()->createFeature(theID);
428 boost::shared_ptr<Model_Document> aDocToAdd = boost::dynamic_pointer_cast<Model_Document>(
429 aFeature->documentToAdd());
431 TDF_Label aFeatureLab;
432 if (!aFeature->isAction()) { // do not add action to the data model
433 TDF_Label aFeaturesLab = aDocToAdd->featuresLabel();
434 aFeatureLab = aFeaturesLab.NewChild();
435 aDocToAdd->initData(aFeature, aFeatureLab, TAG_FEATURE_ARGUMENTS);
436 // keep the feature ID to restore document later correctly
437 TDataStd_Comment::Set(aFeatureLab, aFeature->getKind().c_str());
438 aDocToAdd->myObjs.Bind(aFeatureLab, aFeature);
439 // store feature in the history of features array
440 if (aFeature->isInHistory()) {
441 AddToRefArray(aFeaturesLab, aFeatureLab);
444 if (!aFeature->isAction()) { // do not add action to the data model
445 // event: feature is added
446 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
447 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
448 } else { // feature must be executed
449 // no creation event => updater not working, problem with remove part
456 /// Appenad to the array of references a new referenced label.
457 /// If theIndex is not -1, removes element at thisindex, not theReferenced.
458 /// \returns the index of removed element
459 static int RemoveFromRefArray(TDF_Label theArrayLab, TDF_Label theReferenced, const int theIndex =
462 int aResult = -1; // no returned
463 Handle(TDataStd_ReferenceArray) aRefs;
464 if (theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
465 if (aRefs->Length() == 1) { // just erase an array
466 if ((theIndex == -1 && aRefs->Value(0) == theReferenced) || theIndex == 0) {
467 theArrayLab.ForgetAttribute(TDataStd_ReferenceArray::GetID());
470 } else { // reduce the array
471 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
473 int aCount = aRefs->Lower();
474 for (int a = aCount; a <= aRefs->Upper(); a++, aCount++) {
475 if ((theIndex == -1 && aRefs->Value(a) == theReferenced) || theIndex == a) {
479 aNewArray->SetValue(aCount, aRefs->Value(a));
482 aRefs->SetInternalArray(aNewArray);
488 void Model_Document::removeFeature(FeaturePtr theFeature, const bool theCheck)
491 // check the feature: it must have no depended objects on it
492 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
493 for(; aResIter != theFeature->results().cend(); aResIter++) {
494 boost::shared_ptr<Model_Data> aData =
495 boost::dynamic_pointer_cast<Model_Data>((*aResIter)->data());
496 if (aData && !aData->refsToMe().empty()) {
498 "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
504 boost::shared_ptr<Model_Data> aData = boost::static_pointer_cast<Model_Data>(theFeature->data());
505 TDF_Label aFeatureLabel = aData->label().Father();
506 if (myObjs.IsBound(aFeatureLabel))
507 myObjs.UnBind(aFeatureLabel);
509 return; // not found feature => do not remove
512 // erase all attributes under the label of feature
513 aFeatureLabel.ForgetAllAttributes();
514 // remove it from the references array
515 if (theFeature->isInHistory()) {
516 RemoveFromRefArray(featuresLabel(), aFeatureLabel);
518 // event: feature is deleted
519 ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
522 FeaturePtr Model_Document::feature(TDF_Label& theLabel)
524 if (myObjs.IsBound(theLabel))
525 return myObjs.Find(theLabel);
526 return FeaturePtr(); // not found
529 ObjectPtr Model_Document::object(TDF_Label theLabel)
531 // try feature by label
532 FeaturePtr aFeature = feature(theLabel);
534 return feature(theLabel);
535 TDF_Label aFeatureLabel = theLabel.Father().Father(); // let's suppose it is result
536 aFeature = feature(aFeatureLabel);
538 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
539 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
540 for (; aRIter != aResults.cend(); aRIter++) {
541 boost::shared_ptr<Model_Data> aResData = boost::dynamic_pointer_cast<Model_Data>(
543 if (aResData->label().Father().IsEqual(theLabel))
547 return FeaturePtr(); // not found
550 boost::shared_ptr<ModelAPI_Document> Model_Document::subDocument(std::string theDocID)
552 // just store sub-document identifier here to manage it later
553 if (mySubs.find(theDocID) == mySubs.end())
554 mySubs.insert(theDocID);
555 return Model_Application::getApplication()->getDocument(theDocID);
558 boost::shared_ptr<Model_Document> Model_Document::subDoc(std::string theDocID)
560 // just store sub-document identifier here to manage it later
561 if (mySubs.find(theDocID) == mySubs.end())
562 mySubs.insert(theDocID);
563 return boost::dynamic_pointer_cast<Model_Document>(
564 Model_Application::getApplication()->getDocument(theDocID));
567 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex,
568 const bool theHidden)
570 if (theGroupID == ModelAPI_Feature::group()) {
573 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
574 for (; aLabIter.More(); aLabIter.Next()) {
575 if (theIndex == anIndex) {
576 TDF_Label aFLabel = aLabIter.Value()->Label();
577 return feature(aFLabel);
582 Handle(TDataStd_ReferenceArray) aRefs;
583 if (!featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
585 if (aRefs->Lower() > theIndex || aRefs->Upper() < theIndex)
587 TDF_Label aFeatureLabel = aRefs->Value(theIndex);
588 return feature(aFeatureLabel);
591 // comment must be in any feature: it is kind
593 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
594 for (; aLabIter.More(); aLabIter.Next()) {
595 TDF_Label aFLabel = aLabIter.Value()->Label();
596 FeaturePtr aFeature = feature(aFLabel);
597 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
598 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
599 for (; aRIter != aResults.cend(); aRIter++) {
600 if ((*aRIter)->groupName() != theGroupID) continue;
601 bool isIn = theHidden && (*aRIter)->isInHistory();
602 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
603 isIn = !(*aRIter)->isConcealed();
606 if (anIndex == theIndex)
617 int Model_Document::size(const std::string& theGroupID, const bool theHidden)
620 if (theGroupID == ModelAPI_Feature::group()) {
622 return myObjs.Size();
624 Handle(TDataStd_ReferenceArray) aRefs;
625 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
626 return aRefs->Length();
629 // comment must be in any feature: it is kind
630 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
631 for (; aLabIter.More(); aLabIter.Next()) {
632 TDF_Label aFLabel = aLabIter.Value()->Label();
633 FeaturePtr aFeature = feature(aFLabel);
634 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
635 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
636 for (; aRIter != aResults.cend(); aRIter++) {
637 if ((*aRIter)->groupName() != theGroupID) continue;
638 bool isIn = theHidden;
639 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
640 isIn = !(*aRIter)->isConcealed();
647 // group is not found
651 TDF_Label Model_Document::featuresLabel()
653 return myDoc->Main().FindChild(TAG_OBJECTS);
656 void Model_Document::setUniqueName(FeaturePtr theFeature)
658 if (!theFeature->data()->name().empty())
659 return; // not needed, name is already defined
660 std::string aName; // result
661 // first count all objects of such kind to start with index = count + 1
663 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
664 for (; aFIter.More(); aFIter.Next()) {
665 if (aFIter.Value()->getKind() == theFeature->getKind())
668 // generate candidate name
669 std::stringstream aNameStream;
670 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
671 aName = aNameStream.str();
672 // check this is unique, if not, increase index by 1
673 for (aFIter.Initialize(myObjs); aFIter.More();) {
674 FeaturePtr aFeature = aFIter.Value();
675 bool isSameName = aFeature->data()->name() == aName;
676 if (!isSameName) { // check also results to avoid same results names (actual for Parts)
677 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
678 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
679 for (; aRIter != aResults.cend(); aRIter++) {
680 isSameName = (*aRIter)->data()->name() == aName;
685 std::stringstream aNameStream;
686 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
687 aName = aNameStream.str();
688 // reinitialize iterator to make sure a new name is unique
689 aFIter.Initialize(myObjs);
693 theFeature->data()->setName(aName);
696 void Model_Document::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
698 boost::shared_ptr<ModelAPI_Document> aThis = Model_Application::getApplication()->getDocument(
700 boost::shared_ptr<Model_Data> aData(new Model_Data);
701 aData->setLabel(theLab.FindChild(theTag));
702 aData->setObject(theObj);
703 theObj->setDoc(aThis);
704 theObj->setData(aData);
705 FeaturePtr aFeature = boost::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
707 setUniqueName(aFeature); // must be before "initAttributes" because duplicate part uses name
708 aFeature->initAttributes();
712 void Model_Document::synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences)
714 boost::shared_ptr<ModelAPI_Document> aThis =
715 Model_Application::getApplication()->getDocument(myID);
716 // after all updates, sends a message that groups of features were created or updated
717 boost::static_pointer_cast<Model_Session>(Model_Session::get())
718 ->setCheckTransactions(false);
719 Events_Loop* aLoop = Events_Loop::loop();
720 aLoop->activateFlushes(false);
722 // update all objects by checking are they of labels or not
723 std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
724 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
725 for (; aLabIter.More(); aLabIter.Next()) {
726 TDF_Label aFeatureLabel = aLabIter.Value()->Label();
728 if (!myObjs.IsBound(aFeatureLabel)) { // a new feature is inserted
730 aFeature = ModelAPI_Session::get()->createFeature(
731 TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
733 if (!aFeature) { // somethig is wrong, most probably, the opened document has invalid structure
734 Events_Error::send("Invalid type of object in the document");
735 aLabIter.Value()->Label().ForgetAllAttributes();
738 // this must be before "setData" to redo the sketch line correctly
739 myObjs.Bind(aFeatureLabel, aFeature);
740 aNewFeatures.insert(aFeature);
741 initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
743 // event: model is updated
744 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
745 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
746 } else { // nothing is changed, both iterators are incremented
747 aFeature = myObjs.Find(aFeatureLabel);
748 aKeptFeatures.insert(aFeature);
749 if (theMarkUpdated) {
750 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
751 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
755 // update results of thefeatures (after features created because they may be connected, like sketch and sub elements)
756 TDF_ChildIDIterator aLabIter2(featuresLabel(), TDataStd_Comment::GetID());
757 for (; aLabIter2.More(); aLabIter2.Next()) {
758 TDF_Label aFeatureLabel = aLabIter2.Value()->Label();
759 if (myObjs.IsBound(aFeatureLabel)) { // a new feature is inserted
760 FeaturePtr aFeature = myObjs.Find(aFeatureLabel);
761 updateResults(aFeature);
765 // check all features are checked: if not => it was removed
766 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
767 while (aFIter.More()) {
768 if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
769 && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
770 FeaturePtr aFeature = aFIter.Value();
771 // event: model is updated
772 //if (aFeature->isInHistory()) {
773 ModelAPI_EventCreator::get()->sendDeleted(aThis, ModelAPI_Feature::group());
775 // results of this feature must be redisplayed (hided)
776 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
777 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
778 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
779 // redisplay also removed feature (used for sketch and AISObject)
780 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
782 // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
783 TDF_Label aLab = aFIter.Key();
790 if (theUpdateReferences) {
791 synchronizeBackRefs();
794 myExecuteFeatures = false;
795 aLoop->activateFlushes(true);
797 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
798 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
799 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
800 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
801 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
802 boost::static_pointer_cast<Model_Session>(Model_Session::get())
803 ->setCheckTransactions(true);
804 myExecuteFeatures = true;
807 void Model_Document::synchronizeBackRefs()
809 boost::shared_ptr<ModelAPI_Document> aThis =
810 Model_Application::getApplication()->getDocument(myID);
811 // keeps the concealed flags of result to catch the change and create created/deleted events
812 std::list<std::pair<ResultPtr, bool> > aConcealed;
813 // first cycle: erase all data about back-references
814 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myObjs);
815 for(; aFeatures.More(); aFeatures.Next()) {
816 FeaturePtr aFeature = aFeatures.Value();
817 boost::shared_ptr<Model_Data> aFData =
818 boost::dynamic_pointer_cast<Model_Data>(aFeature->data());
820 aFData->eraseBackReferences();
822 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
823 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
824 for (; aRIter != aResults.cend(); aRIter++) {
825 boost::shared_ptr<Model_Data> aResData =
826 boost::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
828 aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
829 aResData->eraseBackReferences();
834 // second cycle: set new back-references: only features may have reference, iterate only them
835 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
836 for(aFeatures.Initialize(myObjs); aFeatures.More(); aFeatures.Next()) {
837 FeaturePtr aFeature = aFeatures.Value();
838 boost::shared_ptr<Model_Data> aFData =
839 boost::dynamic_pointer_cast<Model_Data>(aFeature->data());
841 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
842 aFData->referencesToObjects(aRefs);
843 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRefsIter = aRefs.begin();
844 for(; aRefsIter != aRefs.end(); aRefsIter++) {
845 std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
846 for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
848 boost::shared_ptr<Model_Data> aRefData =
849 boost::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
850 aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
856 std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
857 for(; aCIter != aConcealed.end(); aCIter++) {
858 if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
859 if (aCIter->second) { // was concealed become not => creation event
860 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
861 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
862 } else { // was not concealed become concealed => delete event
863 ModelAPI_EventCreator::get()->sendDeleted(aThis, aCIter->first->groupName());
869 TDF_Label Model_Document::resultLabel(
870 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex)
872 const boost::shared_ptr<Model_Data>& aData =
873 boost::dynamic_pointer_cast<Model_Data>(theFeatureData);
874 return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
877 void Model_Document::storeResult(boost::shared_ptr<ModelAPI_Data> theFeatureData,
878 boost::shared_ptr<ModelAPI_Result> theResult,
879 const int theResultIndex)
881 boost::shared_ptr<ModelAPI_Document> aThis =
882 Model_Application::getApplication()->getDocument(myID);
883 theResult->setDoc(aThis);
884 initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
885 if (theResult->data()->name().empty()) { // if was not initialized, generate event and set a name
886 theResult->data()->setName(theFeatureData->name());
890 boost::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
891 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
893 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
894 TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
895 ObjectPtr anOldObject = object(aLab);
896 boost::shared_ptr<ModelAPI_ResultConstruction> aResult;
898 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
901 aResult = boost::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
902 storeResult(theFeatureData, aResult, theIndex);
907 boost::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
908 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
910 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
911 TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
912 ObjectPtr anOldObject = object(aLab);
913 boost::shared_ptr<ModelAPI_ResultBody> aResult;
915 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
918 aResult = boost::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
919 storeResult(theFeatureData, aResult, theIndex);
924 boost::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
925 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
927 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
928 TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
929 ObjectPtr anOldObject = object(aLab);
930 boost::shared_ptr<ModelAPI_ResultPart> aResult;
932 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
935 aResult = boost::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
936 storeResult(theFeatureData, aResult, theIndex);
941 boost::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
942 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
944 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
945 TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
946 ObjectPtr anOldObject = object(aLab);
947 boost::shared_ptr<ModelAPI_ResultGroup> aResult;
949 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
952 aResult = boost::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
953 storeResult(theFeatureData, aResult, theIndex);
958 boost::shared_ptr<ModelAPI_Feature> Model_Document::feature(
959 const boost::shared_ptr<ModelAPI_Result>& theResult)
961 boost::shared_ptr<Model_Data> aData = boost::dynamic_pointer_cast<Model_Data>(theResult->data());
963 TDF_Label aFeatureLab = aData->label().Father().Father().Father();
964 return feature(aFeatureLab);
969 void Model_Document::updateResults(FeaturePtr theFeature)
971 // for not persistent is will be done by parametric updater automatically
972 //if (!theFeature->isPersistentResult()) return;
973 // check the existing results and remove them if there is nothing on the label
974 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
975 while(aResIter != theFeature->results().cend()) {
976 ResultPtr aBody = boost::dynamic_pointer_cast<ModelAPI_Result>(*aResIter);
978 if (!aBody->data()->isValid()) {
979 // found a disappeared result => remove it
980 theFeature->removeResult(aBody);
981 // start iterate from beginning because iterator is corrupted by removing
982 aResIter = theFeature->results().cbegin();
988 // check that results are presented on all labels
989 int aResSize = theFeature->results().size();
990 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
991 for(; aLabIter.More(); aLabIter.Next()) {
992 // here must be GUID of the feature
993 int aResIndex = aLabIter.Value().Tag() - 1;
995 if (aResSize <= aResIndex) {
996 TDF_Label anArgLab = aLabIter.Value();
997 Handle(TDataStd_Comment) aGroup;
998 if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
999 if (aGroup->Get() == ModelAPI_ResultBody::group().c_str()) {
1000 aNewBody = createBody(theFeature->data(), aResIndex);
1001 } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
1002 aNewBody = createPart(theFeature->data(), aResIndex);
1003 } else if (aGroup->Get() == ModelAPI_ResultConstruction::group().c_str()) {
1004 theFeature->execute(); // construction shapes are needed for sketch solver
1006 } else if (aGroup->Get() == ModelAPI_ResultGroup::group().c_str()) {
1007 aNewBody = createGroup(theFeature->data(), aResIndex);
1009 Events_Error::send(std::string("Unknown type of result is found in the document:") +
1010 TCollection_AsciiString(aGroup->Get()).ToCString());
1014 theFeature->setResult(aNewBody, aResIndex);
1020 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1022 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1025 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1027 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);