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));
151 synchronizeFeatures(false, true);
156 bool Model_Document::save(const char* theFileName, std::list<std::string>& theResults)
158 // create a directory in the root document if it is not yet exist
159 if (this == Model_Session::get()->moduleDocument().get()) {
161 CreateDirectory(theFileName, NULL);
163 mkdir(theFileName, 0x1ff);
166 // filename in the dir is id of document inside of the given directory
167 TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
168 PCDM_StoreStatus aStatus;
170 aStatus = Model_Application::getApplication()->SaveAs(myDoc, aPath);
171 } catch (Standard_Failure) {
172 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
174 std::string("Exception in saving of document: ") + aFail->GetMessageString());
177 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
180 case PCDM_SS_DriverFailure:
181 Events_Error::send(std::string("Can not save document: save driver-library failure"));
183 case PCDM_SS_WriteFailure:
184 Events_Error::send(std::string("Can not save document: file writing failure"));
186 case PCDM_SS_Failure:
188 Events_Error::send(std::string("Can not save document"));
192 myTransactionsAfterSave = 0;
193 if (isDone) { // save also sub-documents if any
194 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
195 std::set<std::string>::iterator aSubIter = mySubs.begin();
196 for (; aSubIter != mySubs.end() && isDone; aSubIter++) {
197 isDone = subDoc(*aSubIter)->save(theFileName, theResults);
203 void Model_Document::close()
205 boost::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
206 if (this != aPM->moduleDocument().get() && this == aPM->activeDocument().get()) {
207 aPM->setActiveDocument(aPM->moduleDocument());
210 std::set<std::string>::iterator aSubIter = mySubs.begin();
211 for (; aSubIter != mySubs.end(); aSubIter++)
212 subDoc(*aSubIter)->close();
214 // close this only if it is module document, otherwise it can be undoed
215 if (this == aPM->moduleDocument().get()) {
216 if (myDoc->CanClose() == CDM_CCS_OK)
218 Model_Application::getApplication()->deleteDocument(myID);
222 void Model_Document::startOperation()
224 if (myDoc->HasOpenCommand()) { // start of nested command
225 if (myNestedNum == -1) {
227 myDoc->InitDeltaCompaction();
229 myIsEmptyTr[myTransactionsAfterSave] = !myDoc->CommitCommand();
230 myTransactionsAfterSave++;
231 myDoc->OpenCommand();
232 } else { // start the simple command
235 // new command for all subs
236 std::set<std::string>::iterator aSubIter = mySubs.begin();
237 for (; aSubIter != mySubs.end(); aSubIter++)
238 subDoc(*aSubIter)->startOperation();
241 bool Model_Document::compactNested()
243 bool allWasEmpty = true;
244 while (myNestedNum != -1) {
245 myTransactionsAfterSave--;
246 if (!myIsEmptyTr[myTransactionsAfterSave]) {
249 myIsEmptyTr.erase(myTransactionsAfterSave);
252 myIsEmptyTr[myTransactionsAfterSave] = allWasEmpty;
253 myTransactionsAfterSave++;
254 myDoc->PerformDeltaCompaction();
258 void Model_Document::finishOperation()
260 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
261 std::set<std::string>::iterator aSubIter = mySubs.begin();
262 for (; aSubIter != mySubs.end(); aSubIter++)
263 subDoc(*aSubIter)->finishOperation();
265 // just to be sure that everybody knows that changes were performed
266 if (!myDoc->HasOpenCommand() && myNestedNum != -1)
267 boost::static_pointer_cast<Model_Session>(Model_Session::get())
268 ->setCheckTransactions(false); // for nested transaction commit
269 synchronizeBackRefs();
270 Events_Loop* aLoop = Events_Loop::loop();
271 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
272 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
273 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
274 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
275 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
276 if (!myDoc->HasOpenCommand() && myNestedNum != -1)
277 boost::static_pointer_cast<Model_Session>(Model_Session::get())
278 ->setCheckTransactions(true); // for nested transaction commit
280 if (myNestedNum != -1) // this nested transaction is owervritten
282 if (!myDoc->HasOpenCommand()) {
283 if (myNestedNum != -1) {
288 // returns false if delta is empty and no transaction was made
289 myIsEmptyTr[myTransactionsAfterSave] = !myDoc->CommitCommand(); // && (myNestedNum == -1);
290 myTransactionsAfterSave++;
294 void Model_Document::abortOperation()
296 if (myNestedNum > 0 && !myDoc->HasOpenCommand()) { // abort all what was done in nested
297 // first compact all nested
298 if (compactNested()) {
299 // for nested it is undo and clear redos
303 myTransactionsAfterSave--;
304 myIsEmptyTr.erase(myTransactionsAfterSave);
306 if (myNestedNum == 0) // abort only high-level
308 myDoc->AbortCommand();
310 synchronizeFeatures(true, false); // references were not changed since transaction start
311 // abort for all subs
312 std::set<std::string>::iterator aSubIter = mySubs.begin();
313 for (; aSubIter != mySubs.end(); aSubIter++)
314 subDoc(*aSubIter)->abortOperation();
317 bool Model_Document::isOperation()
319 // operation is opened for all documents: no need to check subs
320 return myDoc->HasOpenCommand() == Standard_True ;
323 bool Model_Document::isModified()
325 // is modified if at least one operation was commited and not undoed
326 return myTransactionsAfterSave > 0 || isOperation();
329 bool Model_Document::canUndo()
331 if (myDoc->GetAvailableUndos() > 0 && myNestedNum != 0
332 && myTransactionsAfterSave != 0 /* for omitting the first useless transaction */)
334 // check other subs contains operation that can be undoed
335 std::set<std::string>::iterator aSubIter = mySubs.begin();
336 for (; aSubIter != mySubs.end(); aSubIter++)
337 if (subDoc(*aSubIter)->canUndo())
342 void Model_Document::undo()
344 myTransactionsAfterSave--;
347 if (!myIsEmptyTr[myTransactionsAfterSave])
349 synchronizeFeatures(true, true);
351 std::set<std::string>::iterator aSubIter = mySubs.begin();
352 for (; aSubIter != mySubs.end(); aSubIter++)
353 subDoc(*aSubIter)->undo();
356 bool Model_Document::canRedo()
358 if (myDoc->GetAvailableRedos() > 0)
360 // check other subs contains operation that can be redoed
361 std::set<std::string>::iterator aSubIter = mySubs.begin();
362 for (; aSubIter != mySubs.end(); aSubIter++)
363 if (subDoc(*aSubIter)->canRedo())
368 void Model_Document::redo()
370 if (myNestedNum != -1)
372 if (!myIsEmptyTr[myTransactionsAfterSave])
374 myTransactionsAfterSave++;
375 synchronizeFeatures(true, true);
377 std::set<std::string>::iterator aSubIter = mySubs.begin();
378 for (; aSubIter != mySubs.end(); aSubIter++)
379 subDoc(*aSubIter)->redo();
382 /// Appenad to the array of references a new referenced label
383 static void AddToRefArray(TDF_Label& theArrayLab, TDF_Label& theReferenced)
385 Handle(TDataStd_ReferenceArray) aRefs;
386 if (!theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
387 aRefs = TDataStd_ReferenceArray::Set(theArrayLab, 0, 0);
388 aRefs->SetValue(0, theReferenced);
389 } else { // extend array by one more element
390 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
392 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
393 aNewArray->SetValue(a, aRefs->Value(a));
395 aNewArray->SetValue(aRefs->Upper() + 1, theReferenced);
396 aRefs->SetInternalArray(aNewArray);
400 FeaturePtr Model_Document::addFeature(std::string theID)
402 TDF_Label anEmptyLab;
403 FeaturePtr anEmptyFeature;
404 FeaturePtr aFeature = ModelAPI_Session::get()->createFeature(theID);
407 boost::shared_ptr<Model_Document> aDocToAdd = boost::dynamic_pointer_cast<Model_Document>(
408 aFeature->documentToAdd());
410 TDF_Label aFeatureLab;
411 if (!aFeature->isAction()) { // do not add action to the data model
412 TDF_Label aFeaturesLab = aDocToAdd->featuresLabel();
413 aFeatureLab = aFeaturesLab.NewChild();
414 aDocToAdd->initData(aFeature, aFeatureLab, TAG_FEATURE_ARGUMENTS);
415 // keep the feature ID to restore document later correctly
416 TDataStd_Comment::Set(aFeatureLab, aFeature->getKind().c_str());
417 aDocToAdd->myObjs.Bind(aFeatureLab, aFeature);
418 // store feature in the history of features array
419 if (aFeature->isInHistory()) {
420 AddToRefArray(aFeaturesLab, aFeatureLab);
423 if (!aFeature->isAction()) { // do not add action to the data model
424 // event: feature is added
425 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
426 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
427 } else { // feature must be executed
428 // no creation event => updater not working, problem with remove part
435 /// Appenad to the array of references a new referenced label.
436 /// If theIndex is not -1, removes element at thisindex, not theReferenced.
437 /// \returns the index of removed element
438 static int RemoveFromRefArray(TDF_Label theArrayLab, TDF_Label theReferenced, const int theIndex =
441 int aResult = -1; // no returned
442 Handle(TDataStd_ReferenceArray) aRefs;
443 if (theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
444 if (aRefs->Length() == 1) { // just erase an array
445 if ((theIndex == -1 && aRefs->Value(0) == theReferenced) || theIndex == 0) {
446 theArrayLab.ForgetAttribute(TDataStd_ReferenceArray::GetID());
449 } else { // reduce the array
450 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
452 int aCount = aRefs->Lower();
453 for (int a = aCount; a <= aRefs->Upper(); a++, aCount++) {
454 if ((theIndex == -1 && aRefs->Value(a) == theReferenced) || theIndex == a) {
458 aNewArray->SetValue(aCount, aRefs->Value(a));
461 aRefs->SetInternalArray(aNewArray);
467 void Model_Document::removeFeature(FeaturePtr theFeature, const bool theCheck)
470 // check the feature: it must have no depended objects on it
471 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
472 for(; aResIter != theFeature->results().cend(); aResIter++) {
473 boost::shared_ptr<Model_Data> aData =
474 boost::dynamic_pointer_cast<Model_Data>((*aResIter)->data());
475 if (aData && !aData->refsToMe().empty()) {
477 "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
483 boost::shared_ptr<Model_Data> aData = boost::static_pointer_cast<Model_Data>(theFeature->data());
484 TDF_Label aFeatureLabel = aData->label().Father();
485 if (myObjs.IsBound(aFeatureLabel))
486 myObjs.UnBind(aFeatureLabel);
488 return; // not found feature => do not remove
491 // erase all attributes under the label of feature
492 aFeatureLabel.ForgetAllAttributes();
493 // remove it from the references array
494 if (theFeature->isInHistory()) {
495 RemoveFromRefArray(featuresLabel(), aFeatureLabel);
497 // event: feature is deleted
498 ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
501 FeaturePtr Model_Document::feature(TDF_Label& theLabel)
503 if (myObjs.IsBound(theLabel))
504 return myObjs.Find(theLabel);
505 return FeaturePtr(); // not found
508 ObjectPtr Model_Document::object(TDF_Label theLabel)
510 // try feature by label
511 FeaturePtr aFeature = feature(theLabel);
513 return feature(theLabel);
514 TDF_Label aFeatureLabel = theLabel.Father().Father(); // let's suppose it is result
515 aFeature = feature(aFeatureLabel);
517 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
518 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
519 for (; aRIter != aResults.cend(); aRIter++) {
520 boost::shared_ptr<Model_Data> aResData = boost::dynamic_pointer_cast<Model_Data>(
522 if (aResData->label().Father().IsEqual(theLabel))
526 return FeaturePtr(); // not found
529 boost::shared_ptr<ModelAPI_Document> Model_Document::subDocument(std::string theDocID)
531 // just store sub-document identifier here to manage it later
532 if (mySubs.find(theDocID) == mySubs.end())
533 mySubs.insert(theDocID);
534 return Model_Application::getApplication()->getDocument(theDocID);
537 boost::shared_ptr<Model_Document> Model_Document::subDoc(std::string theDocID)
539 // just store sub-document identifier here to manage it later
540 if (mySubs.find(theDocID) == mySubs.end())
541 mySubs.insert(theDocID);
542 return boost::dynamic_pointer_cast<Model_Document>(
543 Model_Application::getApplication()->getDocument(theDocID));
546 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex,
547 const bool theHidden)
549 if (theGroupID == ModelAPI_Feature::group()) {
552 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
553 for (; aLabIter.More(); aLabIter.Next()) {
554 if (theIndex == anIndex) {
555 TDF_Label aFLabel = aLabIter.Value()->Label();
556 return feature(aFLabel);
561 Handle(TDataStd_ReferenceArray) aRefs;
562 if (!featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
564 if (aRefs->Lower() > theIndex || aRefs->Upper() < theIndex)
566 TDF_Label aFeatureLabel = aRefs->Value(theIndex);
567 return feature(aFeatureLabel);
570 // comment must be in any feature: it is kind
572 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
573 for (; aLabIter.More(); aLabIter.Next()) {
574 TDF_Label aFLabel = aLabIter.Value()->Label();
575 FeaturePtr aFeature = feature(aFLabel);
576 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
577 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
578 for (; aRIter != aResults.cend(); aRIter++) {
579 if ((*aRIter)->groupName() != theGroupID) continue;
580 bool isIn = theHidden && (*aRIter)->isInHistory();
581 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
582 isIn = !(*aRIter)->isConcealed();
585 if (anIndex == theIndex)
596 int Model_Document::size(const std::string& theGroupID, const bool theHidden)
599 if (theGroupID == ModelAPI_Feature::group()) {
601 return myObjs.Size();
603 Handle(TDataStd_ReferenceArray) aRefs;
604 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
605 return aRefs->Length();
608 // comment must be in any feature: it is kind
609 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
610 for (; aLabIter.More(); aLabIter.Next()) {
611 TDF_Label aFLabel = aLabIter.Value()->Label();
612 FeaturePtr aFeature = feature(aFLabel);
613 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
614 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
615 for (; aRIter != aResults.cend(); aRIter++) {
616 if ((*aRIter)->groupName() != theGroupID) continue;
617 bool isIn = theHidden;
618 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
619 isIn = !(*aRIter)->isConcealed();
626 // group is not found
630 TDF_Label Model_Document::featuresLabel()
632 return myDoc->Main().FindChild(TAG_OBJECTS);
635 void Model_Document::setUniqueName(FeaturePtr theFeature)
637 if (!theFeature->data()->name().empty())
638 return; // not needed, name is already defined
639 std::string aName; // result
640 // first count all objects of such kind to start with index = count + 1
642 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
643 for (; aFIter.More(); aFIter.Next()) {
644 if (aFIter.Value()->getKind() == theFeature->getKind())
647 // generate candidate name
648 std::stringstream aNameStream;
649 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
650 aName = aNameStream.str();
651 // check this is unique, if not, increase index by 1
652 for (aFIter.Initialize(myObjs); aFIter.More();) {
653 FeaturePtr aFeature = aFIter.Value();
654 bool isSameName = aFeature->data()->name() == aName;
655 if (!isSameName) { // check also results to avoid same results names (actual for Parts)
656 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
657 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
658 for (; aRIter != aResults.cend(); aRIter++) {
659 isSameName = (*aRIter)->data()->name() == aName;
664 std::stringstream aNameStream;
665 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
666 aName = aNameStream.str();
667 // reinitialize iterator to make sure a new name is unique
668 aFIter.Initialize(myObjs);
672 theFeature->data()->setName(aName);
675 void Model_Document::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
677 boost::shared_ptr<ModelAPI_Document> aThis = Model_Application::getApplication()->getDocument(
679 boost::shared_ptr<Model_Data> aData(new Model_Data);
680 aData->setLabel(theLab.FindChild(theTag));
681 aData->setObject(theObj);
682 theObj->setDoc(aThis);
683 theObj->setData(aData);
684 FeaturePtr aFeature = boost::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
686 setUniqueName(aFeature); // must be before "initAttributes" because duplicate part uses name
687 aFeature->initAttributes();
691 void Model_Document::synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences)
693 boost::shared_ptr<ModelAPI_Document> aThis =
694 Model_Application::getApplication()->getDocument(myID);
695 // after all updates, sends a message that groups of features were created or updated
696 boost::static_pointer_cast<Model_Session>(Model_Session::get())
697 ->setCheckTransactions(false);
698 Events_Loop* aLoop = Events_Loop::loop();
699 aLoop->activateFlushes(false);
701 // update all objects by checking are they of labels or not
702 std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
703 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
704 for (; aLabIter.More(); aLabIter.Next()) {
705 TDF_Label aFeatureLabel = aLabIter.Value()->Label();
707 if (!myObjs.IsBound(aFeatureLabel)) { // a new feature is inserted
709 aFeature = ModelAPI_Session::get()->createFeature(
710 TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
712 if (!aFeature) { // somethig is wrong, most probably, the opened document has invalid structure
713 Events_Error::send("Invalid type of object in the document");
714 aLabIter.Value()->Label().ForgetAllAttributes();
717 // this must be before "setData" to redo the sketch line correctly
718 myObjs.Bind(aFeatureLabel, aFeature);
719 aNewFeatures.insert(aFeature);
720 initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
722 // event: model is updated
723 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
724 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
726 // update results of the appeared feature
727 updateResults(aFeature);
728 } else { // nothing is changed, both iterators are incremented
729 aFeature = myObjs.Find(aFeatureLabel);
730 aKeptFeatures.insert(aFeature);
731 if (theMarkUpdated) {
732 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
733 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
735 updateResults(aFeature);
738 // check all features are checked: if not => it was removed
739 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
740 while (aFIter.More()) {
741 if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
742 && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
743 FeaturePtr aFeature = aFIter.Value();
744 // event: model is updated
745 //if (aFeature->isInHistory()) {
746 ModelAPI_EventCreator::get()->sendDeleted(aThis, ModelAPI_Feature::group());
748 // results of this feature must be redisplayed (hided)
749 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
750 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
751 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
752 // redisplay also removed feature (used for sketch and AISObject)
753 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
755 // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
756 TDF_Label aLab = aFIter.Key();
763 if (theUpdateReferences) {
764 synchronizeBackRefs();
767 myExecuteFeatures = false;
768 aLoop->activateFlushes(true);
770 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
771 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
772 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
773 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
774 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
775 boost::static_pointer_cast<Model_Session>(Model_Session::get())
776 ->setCheckTransactions(true);
777 myExecuteFeatures = true;
780 void Model_Document::synchronizeBackRefs()
782 boost::shared_ptr<ModelAPI_Document> aThis =
783 Model_Application::getApplication()->getDocument(myID);
784 // keeps the concealed flags of result to catch the change and create created/deleted events
785 std::list<std::pair<ResultPtr, bool> > aConcealed;
786 // first cycle: erase all data about back-references
787 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myObjs);
788 for(; aFeatures.More(); aFeatures.Next()) {
789 FeaturePtr aFeature = aFeatures.Value();
790 boost::shared_ptr<Model_Data> aFData =
791 boost::dynamic_pointer_cast<Model_Data>(aFeature->data());
793 aFData->eraseBackReferences();
795 const std::list<boost::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
796 std::list<boost::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
797 for (; aRIter != aResults.cend(); aRIter++) {
798 boost::shared_ptr<Model_Data> aResData =
799 boost::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
801 aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
802 aResData->eraseBackReferences();
807 // second cycle: set new back-references: only features may have reference, iterate only them
808 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
809 for(aFeatures.Initialize(myObjs); aFeatures.More(); aFeatures.Next()) {
810 FeaturePtr aFeature = aFeatures.Value();
811 boost::shared_ptr<Model_Data> aFData =
812 boost::dynamic_pointer_cast<Model_Data>(aFeature->data());
814 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
815 aFData->referencesToObjects(aRefs);
816 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRefsIter = aRefs.begin();
817 for(; aRefsIter != aRefs.end(); aRefsIter++) {
818 std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
819 for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
821 boost::shared_ptr<Model_Data> aRefData =
822 boost::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
823 aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
829 std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
830 for(; aCIter != aConcealed.end(); aCIter++) {
831 if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
832 if (aCIter->second) { // was concealed become not => creation event
833 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
834 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
835 } else { // was not concealed become concealed => delete event
836 ModelAPI_EventCreator::get()->sendDeleted(aThis, aCIter->first->groupName());
842 TDF_Label Model_Document::resultLabel(
843 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex)
845 const boost::shared_ptr<Model_Data>& aData =
846 boost::dynamic_pointer_cast<Model_Data>(theFeatureData);
847 return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
850 void Model_Document::storeResult(boost::shared_ptr<ModelAPI_Data> theFeatureData,
851 boost::shared_ptr<ModelAPI_Result> theResult,
852 const int theResultIndex)
854 boost::shared_ptr<ModelAPI_Document> aThis =
855 Model_Application::getApplication()->getDocument(myID);
856 theResult->setDoc(aThis);
857 initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
858 if (theResult->data()->name().empty()) { // if was not initialized, generate event and set a name
859 theResult->data()->setName(theFeatureData->name());
863 boost::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
864 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
866 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
867 TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
868 ObjectPtr anOldObject = object(aLab);
869 boost::shared_ptr<ModelAPI_ResultConstruction> aResult;
871 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
874 aResult = boost::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
875 storeResult(theFeatureData, aResult, theIndex);
880 boost::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
881 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
883 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
884 TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
885 ObjectPtr anOldObject = object(aLab);
886 boost::shared_ptr<ModelAPI_ResultBody> aResult;
888 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
891 aResult = boost::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
892 storeResult(theFeatureData, aResult, theIndex);
897 boost::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
898 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
900 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
901 TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
902 ObjectPtr anOldObject = object(aLab);
903 boost::shared_ptr<ModelAPI_ResultPart> aResult;
905 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
908 aResult = boost::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
909 storeResult(theFeatureData, aResult, theIndex);
914 boost::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
915 const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
917 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
918 TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
919 ObjectPtr anOldObject = object(aLab);
920 boost::shared_ptr<ModelAPI_ResultGroup> aResult;
922 aResult = boost::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
925 aResult = boost::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
926 storeResult(theFeatureData, aResult, theIndex);
931 boost::shared_ptr<ModelAPI_Feature> Model_Document::feature(
932 const boost::shared_ptr<ModelAPI_Result>& theResult)
934 boost::shared_ptr<Model_Data> aData = boost::dynamic_pointer_cast<Model_Data>(theResult->data());
936 TDF_Label aFeatureLab = aData->label().Father().Father().Father();
937 return feature(aFeatureLab);
942 void Model_Document::updateResults(FeaturePtr theFeature)
944 // for not persistent is will be done by parametric updater automatically
945 if (!theFeature->isPersistentResult()) return;
946 // check the existing results and remove them if there is nothing on the label
947 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
948 while(aResIter != theFeature->results().cend()) {
949 ResultBodyPtr aBody = boost::dynamic_pointer_cast<ModelAPI_ResultBody>(*aResIter);
951 if (!aBody->data()->isValid()) {
952 // found a disappeared result => remove it
953 theFeature->removeResult(aBody);
954 // start iterate from beginning because iterator is corrupted by removing
955 aResIter = theFeature->results().cbegin();
961 // check that results are presented on all labels
962 int aResSize = theFeature->results().size();
963 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
964 for(; aLabIter.More(); aLabIter.Next()) {
965 // here must be GUID of the feature
966 int aResIndex = aLabIter.Value().Tag() - 1;
968 if (aResSize <= aResIndex) {
969 TDF_Label anArgLab = aLabIter.Value();
970 Handle(TDataStd_Comment) aGroup;
971 if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
972 if (aGroup->Get() == ModelAPI_ResultBody::group().c_str()) {
973 aNewBody = createBody(theFeature->data(), aResIndex);
974 } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
975 aNewBody = createPart(theFeature->data(), aResIndex);
976 } else if (aGroup->Get() != ModelAPI_ResultConstruction::group().c_str() &&
977 aGroup->Get() != ModelAPI_ResultGroup::group().c_str()) {
978 Events_Error::send(std::string("Unknown type of result is found in the document:") +
979 TCollection_AsciiString(aGroup->Get()).ToCString());
983 theFeature->setResult(aNewBody, aResIndex);
989 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
991 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
994 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
996 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);