1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Document.cxx
4 // Created: 28 Feb 2014
5 // Author: Mikhail PONIKAROV
7 #include <Model_Document.h>
8 #include <Model_Data.h>
9 #include <Model_Application.h>
10 #include <Model_Session.h>
11 #include <Model_Events.h>
12 #include <Model_ResultPart.h>
13 #include <Model_ResultConstruction.h>
14 #include <Model_ResultBody.h>
15 #include <Model_ResultGroup.h>
16 #include <ModelAPI_Validator.h>
17 #include <ModelAPI_CompositeFeature.h>
18 #include <Events_Loop.h>
19 #include <Events_Error.h>
21 #include <TDataStd_Integer.hxx>
22 #include <TDataStd_Comment.hxx>
23 #include <TDF_ChildIDIterator.hxx>
24 #include <TDataStd_ReferenceArray.hxx>
25 #include <TDataStd_HLabelArray1.hxx>
26 #include <TDataStd_Name.hxx>
27 #include <TDF_Reference.hxx>
28 #include <TDF_ChildIDIterator.hxx>
29 #include <TDF_LabelMapHasher.hxx>
30 #include <OSD_File.hxx>
31 #include <OSD_Path.hxx>
39 # define _separator_ '\\'
41 # define _separator_ '/'
44 static const int UNDO_LIMIT = 1000; // number of possible undo operations (big for sketcher)
46 static const int TAG_GENERAL = 1; // general properties tag
47 static const int TAG_OBJECTS = 2; // tag of the objects sub-tree (features, results)
48 static const int TAG_HISTORY = 3; // tag of the history sub-tree (python dump)
51 static const int TAG_FEATURE_ARGUMENTS = 1; ///< where the arguments are located
52 static const int TAG_FEATURE_RESULTS = 2; ///< where the results are located
55 /// 0:1:2 - where features are located
56 /// 0:1:2:N:1 - data of the feature N
57 /// 0:1:2:N:2:K:1 - data of the K result of the feature N
59 Model_Document::Model_Document(const std::string theID, const std::string theKind)
60 : myID(theID), myKind(theKind),
61 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
63 myDoc->SetUndoLimit(UNDO_LIMIT);
64 myTransactionSave = 0;
65 myExecuteFeatures = true;
66 // to have something in the document and avoid empty doc open/save problem
67 // in transaction for nesting correct working
69 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
70 myDoc->CommitCommand();
73 /// Returns the file name of this document by the nameof directory and identifuer of a document
74 static TCollection_ExtendedString DocFileName(const char* theFileName, const std::string& theID)
76 TCollection_ExtendedString aPath((const Standard_CString) theFileName);
77 // remove end-separators
78 while(aPath.Length() && (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
79 aPath.Remove(aPath.Length());
81 aPath += theID.c_str();
82 aPath += ".cbf"; // standard binary file extension
86 bool Model_Document::load(const char* theFileName)
88 Handle(Model_Application) anApp = Model_Application::getApplication();
89 if (this == Model_Session::get()->moduleDocument().get()) {
90 anApp->setLoadPath(theFileName);
92 TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
93 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
95 aStatus = anApp->Open(aPath, myDoc);
96 } catch (Standard_Failure) {
97 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
99 std::string("Exception in opening of document: ") + aFail->GetMessageString());
102 bool isError = aStatus != PCDM_RS_OK;
105 case PCDM_RS_UnknownDocument:
106 Events_Error::send(std::string("Can not open document"));
108 case PCDM_RS_AlreadyRetrieved:
109 Events_Error::send(std::string("Can not open document: already opened"));
111 case PCDM_RS_AlreadyRetrievedAndModified:
113 std::string("Can not open document: already opened and modified"));
115 case PCDM_RS_NoDriver:
116 Events_Error::send(std::string("Can not open document: driver library is not found"));
118 case PCDM_RS_UnknownFileDriver:
119 Events_Error::send(std::string("Can not open document: unknown driver for opening"));
121 case PCDM_RS_OpenError:
122 Events_Error::send(std::string("Can not open document: file open error"));
124 case PCDM_RS_NoVersion:
125 Events_Error::send(std::string("Can not open document: invalid version"));
127 case PCDM_RS_NoModel:
128 Events_Error::send(std::string("Can not open document: no data model"));
130 case PCDM_RS_NoDocument:
131 Events_Error::send(std::string("Can not open document: no document inside"));
133 case PCDM_RS_FormatFailure:
134 Events_Error::send(std::string("Can not open document: format failure"));
136 case PCDM_RS_TypeNotFoundInSchema:
137 Events_Error::send(std::string("Can not open document: invalid object"));
139 case PCDM_RS_UnrecognizedFileFormat:
140 Events_Error::send(std::string("Can not open document: unrecognized file format"));
142 case PCDM_RS_MakeFailure:
143 Events_Error::send(std::string("Can not open document: make failure"));
145 case PCDM_RS_PermissionDenied:
146 Events_Error::send(std::string("Can not open document: permission denied"));
148 case PCDM_RS_DriverFailure:
149 Events_Error::send(std::string("Can not open document: driver failure"));
152 Events_Error::send(std::string("Can not open document: unknown error"));
157 myDoc->SetUndoLimit(UNDO_LIMIT);
158 // to avoid the problem that feature is created in the current, not this, document
159 std::shared_ptr<Model_Session> aSession =
160 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
161 aSession->setActiveDocument(anApp->getDocument(myID), false);
162 aSession->setCheckTransactions(false);
163 synchronizeFeatures(false, true);
164 aSession->setCheckTransactions(true);
165 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
166 aSession->setActiveDocument(anApp->getDocument(myID), true);
171 bool Model_Document::save(const char* theFileName, std::list<std::string>& theResults)
173 // create a directory in the root document if it is not yet exist
174 Handle(Model_Application) anApp = Model_Application::getApplication();
175 if (this == Model_Session::get()->moduleDocument().get()) {
177 CreateDirectory(theFileName, NULL);
179 mkdir(theFileName, 0x1ff);
182 // filename in the dir is id of document inside of the given directory
183 TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
184 PCDM_StoreStatus aStatus;
186 aStatus = anApp->SaveAs(myDoc, aPath);
187 } catch (Standard_Failure) {
188 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
190 std::string("Exception in saving of document: ") + aFail->GetMessageString());
193 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
196 case PCDM_SS_DriverFailure:
197 Events_Error::send(std::string("Can not save document: save driver-library failure"));
199 case PCDM_SS_WriteFailure:
200 Events_Error::send(std::string("Can not save document: file writing failure"));
202 case PCDM_SS_Failure:
204 Events_Error::send(std::string("Can not save document"));
208 myTransactionSave = myTransactions.size();
209 if (isDone) { // save also sub-documents if any
210 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
211 const std::set<std::string> aSubs = subDocuments(false);
212 std::set<std::string>::iterator aSubIter = aSubs.begin();
213 for (; aSubIter != aSubs.end() && isDone; aSubIter++) {
214 if (anApp->isLoadByDemand(*aSubIter)) {
215 // copy not-activated document that is not in the memory
216 std::string aDocName = *aSubIter;
217 if (!aDocName.empty()) {
219 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
220 OSD_Path aPath(aSubPath);
221 OSD_File aFile(aPath);
222 if (aFile.Exists()) {
223 TCollection_AsciiString aDestinationDir(DocFileName(theFileName, aDocName));
224 OSD_Path aDestination(aDestinationDir);
225 aFile.Copy(aDestination);
226 theResults.push_back(aDestinationDir.ToCString());
229 std::string("Can not open file ") + aSubPath.ToCString() + " for saving");
232 } else { // simply save opened document
233 isDone = subDoc(*aSubIter)->save(theFileName, theResults);
240 void Model_Document::close(const bool theForever)
242 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
243 if (this != aPM->moduleDocument().get() && this == aPM->activeDocument().get()) {
244 aPM->setActiveDocument(aPM->moduleDocument());
245 } else if (this == aPM->moduleDocument().get()) {
246 // erase the active document if root is closed
247 aPM->setActiveDocument(DocumentPtr());
250 const std::set<std::string> aSubs = subDocuments(true);
251 std::set<std::string>::iterator aSubIter = aSubs.begin();
252 for (; aSubIter != aSubs.end(); aSubIter++)
253 subDoc(*aSubIter)->close(theForever);
255 // close for thid document needs no transaction in this document
256 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
258 // delete all features of this document
259 std::shared_ptr<ModelAPI_Document> aThis =
260 Model_Application::getApplication()->getDocument(myID);
261 Events_Loop* aLoop = Events_Loop::loop();
262 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeaturesIter(myObjs);
263 for(; aFeaturesIter.More(); aFeaturesIter.Next()) {
264 FeaturePtr aFeature = aFeaturesIter.Value();
265 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
266 ModelAPI_EventCreator::get()->sendDeleted(aThis, ModelAPI_Feature::group());
267 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
268 aFeature->eraseResults();
269 if (theForever) { // issue #294: do not delete content of the document until it can be redone
272 aFeature->data()->execState(ModelAPI_StateMustBeUpdated);
278 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
279 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
281 // close all only if it is really asked, otherwise it can be undoed/redoed
283 if (myDoc->CanClose() == CDM_CCS_OK)
287 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
290 void Model_Document::startOperation()
292 if (myDoc->HasOpenCommand()) { // start of nested command
293 if (myDoc->CommitCommand()) { // commit the current: it will contain all nested after compactification
294 (*myTransactions.rbegin())++; // if has open command, the list is not empty
296 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
297 myDoc->OpenCommand();
298 } else { // start the simple command
301 // starts a new operation
302 myTransactions.push_back(0);
303 if (!myNestedNum.empty())
304 (*myNestedNum.rbegin())++;
306 // new command for all subs
307 const std::set<std::string> aSubs = subDocuments(true);
308 std::set<std::string>::iterator aSubIter = aSubs.begin();
309 for (; aSubIter != aSubs.end(); aSubIter++)
310 subDoc(*aSubIter)->startOperation();
313 void Model_Document::compactNested()
315 if (!myNestedNum.empty()) {
316 int aNumToCompact = *(myNestedNum.rbegin());
317 int aSumOfTransaction = 0;
318 for(int a = 0; a < aNumToCompact; a++) {
319 aSumOfTransaction += *(myTransactions.rbegin());
320 myTransactions.pop_back();
322 // the latest transaction is the start of lower-level operation which startes the nested
323 *(myTransactions.rbegin()) += aSumOfTransaction;
324 myNestedNum.pop_back();
328 bool Model_Document::finishOperation()
330 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
331 static std::shared_ptr<Model_Session> aSession =
332 std::static_pointer_cast<Model_Session>(Model_Session::get());
333 synchronizeBackRefs();
334 Events_Loop* aLoop = Events_Loop::loop();
335 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
336 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
337 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
338 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
339 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
340 // this must be here just after everything is finished but before real transaction stop
341 // to avoid messages about modifications outside of the transaction
342 // and to rebuild everything after all updates and creates
343 if (Model_Session::get()->moduleDocument().get() == this) { // once for root document
344 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
345 static std::shared_ptr<Events_Message> aFinishMsg
346 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
347 Events_Loop::loop()->send(aFinishMsg);
348 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
350 // to avoid "updated" message appearance by updater
351 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
353 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
354 bool aResult = false;
355 const std::set<std::string> aSubs = subDocuments(true);
356 std::set<std::string>::iterator aSubIter = aSubs.begin();
357 for (; aSubIter != aSubs.end(); aSubIter++)
358 if (subDoc(*aSubIter)->finishOperation())
361 // transaction may be empty if this document was created during this transaction (create part)
362 if (!myTransactions.empty() && myDoc->CommitCommand()) { // if commit is successfull, just increment counters
363 (*myTransactions.rbegin())++;
367 if (isNestedClosed) {
370 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
371 aResult = *(myTransactions.rbegin()) != 0;
373 if (!aResult && Model_Session::get()->moduleDocument().get() == this) {
374 // nothing inside in all documents, so remove this transaction from the transactions list
375 undoInternal(true, false);
382 void Model_Document::abortOperation()
384 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
386 undoInternal(false, false);
389 } else { // abort the current
390 int aNumTransactions = *myTransactions.rbegin();
391 myTransactions.pop_back();
392 if (!myNestedNum.empty())
393 (*myNestedNum.rbegin())--;
394 // roll back the needed number of transactions
395 myDoc->AbortCommand();
396 for(int a = 0; a < aNumTransactions; a++)
400 synchronizeFeatures(true, false); // references were not changed since transaction start
401 // abort for all subs
402 const std::set<std::string> aSubs = subDocuments(true);
403 std::set<std::string>::iterator aSubIter = aSubs.begin();
404 for (; aSubIter != aSubs.end(); aSubIter++)
405 subDoc(*aSubIter)->abortOperation();
408 bool Model_Document::isOperation()
410 // operation is opened for all documents: no need to check subs
411 return myDoc->HasOpenCommand() == Standard_True ;
414 bool Model_Document::isModified()
416 // is modified if at least one operation was commited and not undoed
417 return myTransactions.size() != myTransactionSave || isOperation();
420 bool Model_Document::canUndo()
422 if (myDoc->GetAvailableUndos() > 0 && (myNestedNum.empty() || *myNestedNum.rbegin() != 0) &&
423 !myTransactions.empty() /* for omitting the first useless transaction */)
425 // check other subs contains operation that can be undoed
426 const std::set<std::string> aSubs = subDocuments(true);
427 std::set<std::string>::iterator aSubIter = aSubs.begin();
428 for (; aSubIter != aSubs.end(); aSubIter++)
429 if (subDoc(*aSubIter)->canUndo())
434 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
436 int aNumTransactions = *myTransactions.rbegin();
437 myTransactions.pop_back();
438 myRedos.push_back(aNumTransactions);
439 if (!myNestedNum.empty())
440 (*myNestedNum.rbegin())--;
441 // roll back the needed number of transactions
442 for(int a = 0; a < aNumTransactions; a++)
446 synchronizeFeatures(true, true);
449 const std::set<std::string> aSubs = subDocuments(true);
450 std::set<std::string>::iterator aSubIter = aSubs.begin();
451 for (; aSubIter != aSubs.end(); aSubIter++)
452 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
456 void Model_Document::undo()
458 undoInternal(true, true);
461 bool Model_Document::canRedo()
463 if (myDoc->GetAvailableRedos() > 0)
465 // check other subs contains operation that can be redoed
466 const std::set<std::string> aSubs = subDocuments(true);
467 std::set<std::string>::iterator aSubIter = aSubs.begin();
468 for (; aSubIter != aSubs.end(); aSubIter++)
469 if (subDoc(*aSubIter)->canRedo())
474 void Model_Document::redo()
476 if (!myNestedNum.empty())
477 (*myNestedNum.rbegin())++;
478 int aNumRedos = *myRedos.rbegin();
480 myTransactions.push_back(aNumRedos);
481 for(int a = 0; a < aNumRedos; a++)
484 synchronizeFeatures(true, true);
486 const std::set<std::string> aSubs = subDocuments(true);
487 std::set<std::string>::iterator aSubIter = aSubs.begin();
488 for (; aSubIter != aSubs.end(); aSubIter++)
489 subDoc(*aSubIter)->redo();
492 /// Append to the array of references a new referenced label
493 static void AddToRefArray(TDF_Label& theArrayLab, TDF_Label& theReferenced)
495 Handle(TDataStd_ReferenceArray) aRefs;
496 if (!theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
497 aRefs = TDataStd_ReferenceArray::Set(theArrayLab, 0, 0);
498 aRefs->SetValue(0, theReferenced);
499 } else { // extend array by one more element
500 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
502 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
503 aNewArray->SetValue(a, aRefs->Value(a));
505 aNewArray->SetValue(aRefs->Upper() + 1, theReferenced);
506 aRefs->SetInternalArray(aNewArray);
510 FeaturePtr Model_Document::addFeature(std::string theID)
512 TDF_Label anEmptyLab;
513 FeaturePtr anEmptyFeature;
514 FeaturePtr aFeature = ModelAPI_Session::get()->createFeature(theID);
517 std::shared_ptr<Model_Document> aDocToAdd = std::dynamic_pointer_cast<Model_Document>(
518 aFeature->documentToAdd());
520 TDF_Label aFeatureLab;
521 if (!aFeature->isAction()) { // do not add action to the data model
522 TDF_Label aFeaturesLab = aDocToAdd->featuresLabel();
523 aFeatureLab = aFeaturesLab.NewChild();
524 aDocToAdd->initData(aFeature, aFeatureLab, TAG_FEATURE_ARGUMENTS);
525 // keep the feature ID to restore document later correctly
526 TDataStd_Comment::Set(aFeatureLab, aFeature->getKind().c_str());
527 aDocToAdd->myObjs.Bind(aFeatureLab, aFeature);
528 // store feature in the history of features array
529 if (aFeature->isInHistory()) {
530 AddToRefArray(aFeaturesLab, aFeatureLab);
533 if (!aFeature->isAction()) { // do not add action to the data model
534 // event: feature is added
535 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
536 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
537 } else { // feature must be executed
538 // no creation event => updater not working, problem with remove part
545 /// Appenad to the array of references a new referenced label.
546 /// If theIndex is not -1, removes element at thisindex, not theReferenced.
547 /// \returns the index of removed element
548 static int RemoveFromRefArray(TDF_Label theArrayLab, TDF_Label theReferenced, const int theIndex =
551 int aResult = -1; // no returned
552 Handle(TDataStd_ReferenceArray) aRefs;
553 if (theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
554 if (aRefs->Length() == 1) { // just erase an array
555 if ((theIndex == -1 && aRefs->Value(0) == theReferenced) || theIndex == 0) {
556 theArrayLab.ForgetAttribute(TDataStd_ReferenceArray::GetID());
559 } else { // reduce the array
560 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
562 int aCount = aRefs->Lower();
563 for (int a = aCount; a <= aRefs->Upper(); a++, aCount++) {
564 if ((theIndex == -1 && aRefs->Value(a) == theReferenced) || theIndex == a) {
568 aNewArray->SetValue(aCount, aRefs->Value(a));
571 aRefs->SetInternalArray(aNewArray);
577 void Model_Document::refsToFeature(FeaturePtr theFeature,
578 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
579 const bool isSendError)
581 // check the feature: it must have no depended objects on it
582 // the dependencies can be in the feature results
583 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
584 for(; aResIter != theFeature->results().cend(); aResIter++) {
585 ResultPtr aResult = (*aResIter);
586 std::shared_ptr<Model_Data> aData =
587 std::dynamic_pointer_cast<Model_Data>(aResult->data());
588 if (aData.get() != NULL) {
589 const std::set<AttributePtr>& aRefs = aData->refsToMe();
590 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
591 for(; aRefIt != aRefLast; aRefIt++) {
592 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
593 if (aFeature.get() != NULL)
594 theRefs.insert(aFeature);
597 if (!aRefs.empty()) {
598 FeaturePtr aFeature = ModelAPI_Feature::feature(aResult);
599 if (aFeature.get() != NULL)
600 theRefs.insert(aFeature);
604 // the dependencies can be in the feature itself
605 std::shared_ptr<Model_Data> aData =
606 std::dynamic_pointer_cast<Model_Data>(theFeature->data());
607 if (aData && !aData->refsToMe().empty()) {
608 theRefs.insert(theFeature);
611 if (!theRefs.empty() && isSendError) {
613 "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
617 void Model_Document::removeFeature(FeaturePtr theFeature/*, const bool theCheck*/)
619 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theFeature->data());
621 TDF_Label aFeatureLabel = aData->label().Father();
622 if (myObjs.IsBound(aFeatureLabel))
623 myObjs.UnBind(aFeatureLabel);
625 return; // not found feature => do not remove
628 // erase all attributes under the label of feature
629 aFeatureLabel.ForgetAllAttributes();
630 // remove it from the references array
631 if (theFeature->isInHistory()) {
632 RemoveFromRefArray(featuresLabel(), aFeatureLabel);
635 // event: feature is deleted
636 ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
639 FeaturePtr Model_Document::feature(TDF_Label& theLabel) const
641 if (myObjs.IsBound(theLabel))
642 return myObjs.Find(theLabel);
643 return FeaturePtr(); // not found
646 ObjectPtr Model_Document::object(TDF_Label theLabel)
648 // try feature by label
649 FeaturePtr aFeature = feature(theLabel);
651 return feature(theLabel);
652 TDF_Label aFeatureLabel = theLabel.Father().Father(); // let's suppose it is result
653 aFeature = feature(aFeatureLabel);
655 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
656 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
657 for (; aRIter != aResults.cend(); aRIter++) {
658 std::shared_ptr<Model_Data> aResData = std::dynamic_pointer_cast<Model_Data>(
660 if (aResData->label().Father().IsEqual(theLabel))
664 return FeaturePtr(); // not found
667 std::shared_ptr<ModelAPI_Document> Model_Document::subDocument(std::string theDocID)
669 return Model_Application::getApplication()->getDocument(theDocID);
672 const std::set<std::string> Model_Document::subDocuments(const bool theActivatedOnly) const
674 std::set<std::string> aResult;
675 // comment must be in any feature: it is kind
677 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
678 for (; aLabIter.More(); aLabIter.Next()) {
679 TDF_Label aFLabel = aLabIter.Value()->Label();
680 FeaturePtr aFeature = feature(aFLabel);
681 if (aFeature.get()) { // if document is closed the feature may be not in myObjs map
682 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
683 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
684 for (; aRIter != aResults.cend(); aRIter++) {
685 if ((*aRIter)->groupName() != ModelAPI_ResultPart::group()) continue;
686 if ((*aRIter)->isInHistory()) {
687 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRIter);
688 if (aPart && (!theActivatedOnly || aPart->isActivated()))
689 aResult.insert(aPart->data()->name());
697 std::shared_ptr<Model_Document> Model_Document::subDoc(std::string theDocID)
699 // just store sub-document identifier here to manage it later
700 return std::dynamic_pointer_cast<Model_Document>(
701 Model_Application::getApplication()->getDocument(theDocID));
704 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex,
705 const bool theHidden)
707 if (theGroupID == ModelAPI_Feature::group()) {
710 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
711 for (; aLabIter.More(); aLabIter.Next()) {
712 if (theIndex == anIndex) {
713 TDF_Label aFLabel = aLabIter.Value()->Label();
714 return feature(aFLabel);
719 Handle(TDataStd_ReferenceArray) aRefs;
720 if (!featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
722 if (aRefs->Lower() > theIndex || aRefs->Upper() < theIndex)
724 TDF_Label aFeatureLabel = aRefs->Value(theIndex);
725 return feature(aFeatureLabel);
728 // comment must be in any feature: it is kind
730 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
731 for (; aLabIter.More(); aLabIter.Next()) {
732 TDF_Label aFLabel = aLabIter.Value()->Label();
733 FeaturePtr aFeature = feature(aFLabel);
734 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
735 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
736 for (; aRIter != aResults.cend(); aRIter++) {
737 if ((*aRIter)->groupName() != theGroupID) continue;
738 bool isIn = theHidden && (*aRIter)->isInHistory();
739 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
740 isIn = !(*aRIter)->isConcealed();
743 if (anIndex == theIndex)
754 int Model_Document::size(const std::string& theGroupID, const bool theHidden)
757 if (theGroupID == ModelAPI_Feature::group()) {
759 return myObjs.Size();
761 Handle(TDataStd_ReferenceArray) aRefs;
762 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
763 return aRefs->Length();
766 // comment must be in any feature: it is kind
767 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
768 for (; aLabIter.More(); aLabIter.Next()) {
769 TDF_Label aFLabel = aLabIter.Value()->Label();
770 FeaturePtr aFeature = feature(aFLabel);
771 if (!aFeature) // may be on close
773 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
774 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
775 for (; aRIter != aResults.cend(); aRIter++) {
776 if ((*aRIter)->groupName() != theGroupID) continue;
777 bool isIn = theHidden;
778 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
779 isIn = !(*aRIter)->isConcealed();
786 // group is not found
790 TDF_Label Model_Document::featuresLabel() const
792 return myDoc->Main().FindChild(TAG_OBJECTS);
795 void Model_Document::setUniqueName(FeaturePtr theFeature)
797 if (!theFeature->data()->name().empty())
798 return; // not needed, name is already defined
799 std::string aName; // result
800 // first count all objects of such kind to start with index = count + 1
802 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
803 for (; aFIter.More(); aFIter.Next()) {
804 if (aFIter.Value()->getKind() == theFeature->getKind())
807 // generate candidate name
808 std::stringstream aNameStream;
809 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
810 aName = aNameStream.str();
811 // check this is unique, if not, increase index by 1
812 for (aFIter.Initialize(myObjs); aFIter.More();) {
813 FeaturePtr aFeature = aFIter.Value();
814 bool isSameName = aFeature->data()->name() == aName;
815 if (!isSameName) { // check also results to avoid same results names (actual for Parts)
816 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
817 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
818 for (; aRIter != aResults.cend(); aRIter++) {
819 isSameName = (*aRIter)->data()->name() == aName;
824 std::stringstream aNameStream;
825 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
826 aName = aNameStream.str();
827 // reinitialize iterator to make sure a new name is unique
828 aFIter.Initialize(myObjs);
832 theFeature->data()->setName(aName);
835 void Model_Document::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
837 std::shared_ptr<ModelAPI_Document> aThis = Model_Application::getApplication()->getDocument(
839 std::shared_ptr<Model_Data> aData(new Model_Data);
840 aData->setLabel(theLab.FindChild(theTag));
841 aData->setObject(theObj);
842 theObj->setDoc(aThis);
843 theObj->setData(aData);
844 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
846 setUniqueName(aFeature); // must be before "initAttributes" because duplicate part uses name
847 aFeature->initAttributes();
851 void Model_Document::synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences)
853 std::shared_ptr<ModelAPI_Document> aThis =
854 Model_Application::getApplication()->getDocument(myID);
855 // after all updates, sends a message that groups of features were created or updated
856 Events_Loop* aLoop = Events_Loop::loop();
857 aLoop->activateFlushes(false);
859 // update all objects by checking are they of labels or not
860 std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
861 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
862 for (; aLabIter.More(); aLabIter.Next()) {
863 TDF_Label aFeatureLabel = aLabIter.Value()->Label();
865 if (!myObjs.IsBound(aFeatureLabel)) { // a new feature is inserted
867 aFeature = ModelAPI_Session::get()->createFeature(
868 TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
870 if (!aFeature) { // somethig is wrong, most probably, the opened document has invalid structure
871 Events_Error::send("Invalid type of object in the document");
872 aLabIter.Value()->Label().ForgetAllAttributes();
875 // this must be before "setData" to redo the sketch line correctly
876 myObjs.Bind(aFeatureLabel, aFeature);
877 aNewFeatures.insert(aFeature);
878 initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
880 // event: model is updated
881 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
882 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
883 } else { // nothing is changed, both iterators are incremented
884 aFeature = myObjs.Find(aFeatureLabel);
885 aKeptFeatures.insert(aFeature);
886 if (theMarkUpdated) {
887 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
888 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
892 // update results of thefeatures (after features created because they may be connected, like sketch and sub elements)
893 std::list<FeaturePtr> aComposites; // composites must be updated after their subs (issue 360)
894 TDF_ChildIDIterator aLabIter2(featuresLabel(), TDataStd_Comment::GetID());
895 for (; aLabIter2.More(); aLabIter2.Next()) {
896 TDF_Label aFeatureLabel = aLabIter2.Value()->Label();
897 if (myObjs.IsBound(aFeatureLabel)) { // a new feature is inserted
898 FeaturePtr aFeature = myObjs.Find(aFeatureLabel);
899 if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature).get())
900 aComposites.push_back(aFeature);
901 updateResults(aFeature);
904 std::list<FeaturePtr>::iterator aComposite = aComposites.begin();
905 for(; aComposite != aComposites.end(); aComposite++) {
906 updateResults(*aComposite);
909 // check all features are checked: if not => it was removed
910 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
911 while (aFIter.More()) {
912 if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
913 && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
914 FeaturePtr aFeature = aFIter.Value();
915 // event: model is updated
916 //if (aFeature->isInHistory()) {
917 ModelAPI_EventCreator::get()->sendDeleted(aThis, ModelAPI_Feature::group());
919 // results of this feature must be redisplayed (hided)
920 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
921 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
922 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
923 // redisplay also removed feature (used for sketch and AISObject)
924 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
926 // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
927 myObjs.UnBind(aFIter.Key());
928 // reinitialize iterator because unbind may corrupt the previous order in the map
929 aFIter.Initialize(myObjs);
934 if (theUpdateReferences) {
935 synchronizeBackRefs();
938 myExecuteFeatures = false;
939 aLoop->activateFlushes(true);
941 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
942 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
943 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
944 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
945 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
946 myExecuteFeatures = true;
949 void Model_Document::synchronizeBackRefs()
951 std::shared_ptr<ModelAPI_Document> aThis =
952 Model_Application::getApplication()->getDocument(myID);
953 // keeps the concealed flags of result to catch the change and create created/deleted events
954 std::list<std::pair<ResultPtr, bool> > aConcealed;
955 // first cycle: erase all data about back-references
956 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myObjs);
957 for(; aFeatures.More(); aFeatures.Next()) {
958 FeaturePtr aFeature = aFeatures.Value();
959 std::shared_ptr<Model_Data> aFData =
960 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
962 aFData->eraseBackReferences();
964 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
965 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
966 for (; aRIter != aResults.cend(); aRIter++) {
967 std::shared_ptr<Model_Data> aResData =
968 std::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
970 aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
971 aResData->eraseBackReferences();
976 // second cycle: set new back-references: only features may have reference, iterate only them
977 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
978 for(aFeatures.Initialize(myObjs); aFeatures.More(); aFeatures.Next()) {
979 FeaturePtr aFeature = aFeatures.Value();
980 std::shared_ptr<Model_Data> aFData =
981 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
983 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
984 aFData->referencesToObjects(aRefs);
985 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRefsIter = aRefs.begin();
986 for(; aRefsIter != aRefs.end(); aRefsIter++) {
987 std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
988 for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
990 std::shared_ptr<Model_Data> aRefData =
991 std::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
992 aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
998 std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
999 for(; aCIter != aConcealed.end(); aCIter++) {
1000 if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
1001 if (aCIter->second) { // was concealed become not => creation event
1002 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
1003 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
1004 } else { // was not concealed become concealed => delete event
1005 ModelAPI_EventCreator::get()->sendDeleted(aThis, aCIter->first->groupName());
1006 // redisplay for the viewer (it must be disappeared also)
1007 static Events_ID EVENT_DISP =
1008 Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1009 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, EVENT_DISP);
1015 TDF_Label Model_Document::resultLabel(
1016 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex)
1018 const std::shared_ptr<Model_Data>& aData =
1019 std::dynamic_pointer_cast<Model_Data>(theFeatureData);
1020 return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
1023 void Model_Document::storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
1024 std::shared_ptr<ModelAPI_Result> theResult,
1025 const int theResultIndex)
1027 std::shared_ptr<ModelAPI_Document> aThis =
1028 Model_Application::getApplication()->getDocument(myID);
1029 theResult->setDoc(aThis);
1030 initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
1031 if (theResult->data()->name().empty()) { // if was not initialized, generate event and set a name
1032 theResult->data()->setName(theFeatureData->name());
1036 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1037 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1039 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1040 TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
1041 ObjectPtr anOldObject = object(aLab);
1042 std::shared_ptr<ModelAPI_ResultConstruction> aResult;
1044 aResult = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
1047 aResult = std::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
1048 storeResult(theFeatureData, aResult, theIndex);
1053 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1054 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1056 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1057 TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
1058 ObjectPtr anOldObject = object(aLab);
1059 std::shared_ptr<ModelAPI_ResultBody> aResult;
1061 aResult = std::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
1064 aResult = std::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
1065 storeResult(theFeatureData, aResult, theIndex);
1070 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1071 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1073 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1074 TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
1075 ObjectPtr anOldObject = object(aLab);
1076 std::shared_ptr<ModelAPI_ResultPart> aResult;
1078 aResult = std::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
1081 aResult = std::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
1082 storeResult(theFeatureData, aResult, theIndex);
1087 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1088 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1090 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1091 TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
1092 ObjectPtr anOldObject = object(aLab);
1093 std::shared_ptr<ModelAPI_ResultGroup> aResult;
1095 aResult = std::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
1098 aResult = std::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
1099 storeResult(theFeatureData, aResult, theIndex);
1104 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1105 const std::shared_ptr<ModelAPI_Result>& theResult)
1107 std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1109 TDF_Label aFeatureLab = aData->label().Father().Father().Father();
1110 return feature(aFeatureLab);
1112 return FeaturePtr();
1115 void Model_Document::updateResults(FeaturePtr theFeature)
1117 // for not persistent is will be done by parametric updater automatically
1118 //if (!theFeature->isPersistentResult()) return;
1119 // check the existing results and remove them if there is nothing on the label
1120 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
1121 while(aResIter != theFeature->results().cend()) {
1122 ResultPtr aBody = std::dynamic_pointer_cast<ModelAPI_Result>(*aResIter);
1124 if (!aBody->data()->isValid()) {
1125 // found a disappeared result => remove it
1126 theFeature->removeResult(aBody);
1127 // start iterate from beginning because iterator is corrupted by removing
1128 aResIter = theFeature->results().cbegin();
1134 // it may be on undo
1135 if (!theFeature->data() || !theFeature->data()->isValid())
1137 // check that results are presented on all labels
1138 int aResSize = theFeature->results().size();
1139 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
1140 for(; aLabIter.More(); aLabIter.Next()) {
1141 // here must be GUID of the feature
1142 int aResIndex = aLabIter.Value().Tag() - 1;
1144 if (aResSize <= aResIndex) {
1145 TDF_Label anArgLab = aLabIter.Value();
1146 Handle(TDataStd_Comment) aGroup;
1147 if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
1148 if (aGroup->Get() == ModelAPI_ResultBody::group().c_str()) {
1149 aNewBody = createBody(theFeature->data(), aResIndex);
1150 } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
1151 aNewBody = createPart(theFeature->data(), aResIndex);
1152 } else if (aGroup->Get() == ModelAPI_ResultConstruction::group().c_str()) {
1153 theFeature->execute(); // construction shapes are needed for sketch solver
1155 } else if (aGroup->Get() == ModelAPI_ResultGroup::group().c_str()) {
1156 aNewBody = createGroup(theFeature->data(), aResIndex);
1158 Events_Error::send(std::string("Unknown type of result is found in the document:") +
1159 TCollection_AsciiString(aGroup->Get()).ToCString());
1163 theFeature->setResult(aNewBody, aResIndex);
1169 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1171 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1174 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1176 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1179 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1181 myNamingNames[theName] = theLabel;
1184 TDF_Label Model_Document::findNamingName(std::string theName)
1186 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1187 if (aFind == myNamingNames.end())
1188 return TDF_Label(); // not found
1189 return aFind->second;
1192 ResultPtr Model_Document::findByName(const std::string theName)
1194 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator anObjIter(myObjs);
1195 for(; anObjIter.More(); anObjIter.Next()) {
1196 FeaturePtr& aFeature = anObjIter.ChangeValue();
1197 if (!aFeature) // may be on close
1199 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
1200 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
1201 for (; aRIter != aResults.cend(); aRIter++) {
1202 if (aRIter->get() && (*aRIter)->data() && (*aRIter)->data()->isValid() &&
1203 (*aRIter)->data()->name() == theName) {