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 const std::set<AttributePtr>& aRefs = aData->refsToMe();
609 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
610 for(; aRefIt != aRefLast; aRefIt++) {
611 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
612 if (aFeature.get() != NULL)
613 theRefs.insert(aFeature);
617 if (!theRefs.empty() && isSendError) {
619 "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
623 void Model_Document::removeFeature(FeaturePtr theFeature/*, const bool theCheck*/)
625 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theFeature->data());
627 TDF_Label aFeatureLabel = aData->label().Father();
628 if (myObjs.IsBound(aFeatureLabel))
629 myObjs.UnBind(aFeatureLabel);
631 return; // not found feature => do not remove
634 // erase all attributes under the label of feature
635 aFeatureLabel.ForgetAllAttributes();
636 // remove it from the references array
637 if (theFeature->isInHistory()) {
638 RemoveFromRefArray(featuresLabel(), aFeatureLabel);
641 // event: feature is deleted
642 ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
645 FeaturePtr Model_Document::feature(TDF_Label& theLabel) const
647 if (myObjs.IsBound(theLabel))
648 return myObjs.Find(theLabel);
649 return FeaturePtr(); // not found
652 ObjectPtr Model_Document::object(TDF_Label theLabel)
654 // try feature by label
655 FeaturePtr aFeature = feature(theLabel);
657 return feature(theLabel);
658 TDF_Label aFeatureLabel = theLabel.Father().Father(); // let's suppose it is result
659 aFeature = feature(aFeatureLabel);
661 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
662 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
663 for (; aRIter != aResults.cend(); aRIter++) {
664 std::shared_ptr<Model_Data> aResData = std::dynamic_pointer_cast<Model_Data>(
666 if (aResData->label().Father().IsEqual(theLabel))
670 return FeaturePtr(); // not found
673 std::shared_ptr<ModelAPI_Document> Model_Document::subDocument(std::string theDocID)
675 return Model_Application::getApplication()->getDocument(theDocID);
678 const std::set<std::string> Model_Document::subDocuments(const bool theActivatedOnly) const
680 std::set<std::string> aResult;
681 // comment must be in any feature: it is kind
683 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
684 for (; aLabIter.More(); aLabIter.Next()) {
685 TDF_Label aFLabel = aLabIter.Value()->Label();
686 FeaturePtr aFeature = feature(aFLabel);
687 if (aFeature.get()) { // if document is closed the feature may be not in myObjs map
688 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
689 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
690 for (; aRIter != aResults.cend(); aRIter++) {
691 if ((*aRIter)->groupName() != ModelAPI_ResultPart::group()) continue;
692 if ((*aRIter)->isInHistory()) {
693 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRIter);
694 if (aPart && (!theActivatedOnly || aPart->isActivated()))
695 aResult.insert(aPart->data()->name());
703 std::shared_ptr<Model_Document> Model_Document::subDoc(std::string theDocID)
705 // just store sub-document identifier here to manage it later
706 return std::dynamic_pointer_cast<Model_Document>(
707 Model_Application::getApplication()->getDocument(theDocID));
710 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex,
711 const bool theHidden)
713 if (theGroupID == ModelAPI_Feature::group()) {
716 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
717 for (; aLabIter.More(); aLabIter.Next()) {
718 if (theIndex == anIndex) {
719 TDF_Label aFLabel = aLabIter.Value()->Label();
720 return feature(aFLabel);
725 Handle(TDataStd_ReferenceArray) aRefs;
726 if (!featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
728 if (aRefs->Lower() > theIndex || aRefs->Upper() < theIndex)
730 TDF_Label aFeatureLabel = aRefs->Value(theIndex);
731 return feature(aFeatureLabel);
734 // comment must be in any feature: it is kind
736 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
737 for (; aLabIter.More(); aLabIter.Next()) {
738 TDF_Label aFLabel = aLabIter.Value()->Label();
739 FeaturePtr aFeature = feature(aFLabel);
740 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
741 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
742 for (; aRIter != aResults.cend(); aRIter++) {
743 if ((*aRIter)->groupName() != theGroupID) continue;
744 bool isIn = theHidden && (*aRIter)->isInHistory();
745 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
746 isIn = !(*aRIter)->isConcealed();
749 if (anIndex == theIndex)
760 int Model_Document::size(const std::string& theGroupID, const bool theHidden)
763 if (theGroupID == ModelAPI_Feature::group()) {
765 return myObjs.Size();
767 Handle(TDataStd_ReferenceArray) aRefs;
768 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
769 return aRefs->Length();
772 // comment must be in any feature: it is kind
773 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
774 for (; aLabIter.More(); aLabIter.Next()) {
775 TDF_Label aFLabel = aLabIter.Value()->Label();
776 FeaturePtr aFeature = feature(aFLabel);
777 if (!aFeature) // may be on close
779 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
780 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
781 for (; aRIter != aResults.cend(); aRIter++) {
782 if ((*aRIter)->groupName() != theGroupID) continue;
783 bool isIn = theHidden;
784 if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
785 isIn = !(*aRIter)->isConcealed();
792 // group is not found
796 TDF_Label Model_Document::featuresLabel() const
798 return myDoc->Main().FindChild(TAG_OBJECTS);
801 void Model_Document::setUniqueName(FeaturePtr theFeature)
803 if (!theFeature->data()->name().empty())
804 return; // not needed, name is already defined
805 std::string aName; // result
806 // first count all objects of such kind to start with index = count + 1
808 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
809 for (; aFIter.More(); aFIter.Next()) {
810 if (aFIter.Value()->getKind() == theFeature->getKind())
813 // generate candidate name
814 std::stringstream aNameStream;
815 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
816 aName = aNameStream.str();
817 // check this is unique, if not, increase index by 1
818 for (aFIter.Initialize(myObjs); aFIter.More();) {
819 FeaturePtr aFeature = aFIter.Value();
820 bool isSameName = aFeature->data()->name() == aName;
821 if (!isSameName) { // check also results to avoid same results names (actual for Parts)
822 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
823 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
824 for (; aRIter != aResults.cend(); aRIter++) {
825 isSameName = (*aRIter)->data()->name() == aName;
830 std::stringstream aNameStream;
831 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
832 aName = aNameStream.str();
833 // reinitialize iterator to make sure a new name is unique
834 aFIter.Initialize(myObjs);
838 theFeature->data()->setName(aName);
841 void Model_Document::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
843 std::shared_ptr<ModelAPI_Document> aThis = Model_Application::getApplication()->getDocument(
845 std::shared_ptr<Model_Data> aData(new Model_Data);
846 aData->setLabel(theLab.FindChild(theTag));
847 aData->setObject(theObj);
848 theObj->setDoc(aThis);
849 theObj->setData(aData);
850 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
852 setUniqueName(aFeature); // must be before "initAttributes" because duplicate part uses name
853 aFeature->initAttributes();
857 void Model_Document::synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences)
859 std::shared_ptr<ModelAPI_Document> aThis =
860 Model_Application::getApplication()->getDocument(myID);
861 // after all updates, sends a message that groups of features were created or updated
862 Events_Loop* aLoop = Events_Loop::loop();
863 aLoop->activateFlushes(false);
865 // update all objects by checking are they of labels or not
866 std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
867 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
868 for (; aLabIter.More(); aLabIter.Next()) {
869 TDF_Label aFeatureLabel = aLabIter.Value()->Label();
871 if (!myObjs.IsBound(aFeatureLabel)) { // a new feature is inserted
873 aFeature = ModelAPI_Session::get()->createFeature(
874 TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
876 if (!aFeature) { // somethig is wrong, most probably, the opened document has invalid structure
877 Events_Error::send("Invalid type of object in the document");
878 aLabIter.Value()->Label().ForgetAllAttributes();
881 // this must be before "setData" to redo the sketch line correctly
882 myObjs.Bind(aFeatureLabel, aFeature);
883 aNewFeatures.insert(aFeature);
884 initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
886 // event: model is updated
887 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
888 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
889 } else { // nothing is changed, both iterators are incremented
890 aFeature = myObjs.Find(aFeatureLabel);
891 aKeptFeatures.insert(aFeature);
892 if (theMarkUpdated) {
893 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
894 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
898 // update results of thefeatures (after features created because they may be connected, like sketch and sub elements)
899 std::list<FeaturePtr> aComposites; // composites must be updated after their subs (issue 360)
900 TDF_ChildIDIterator aLabIter2(featuresLabel(), TDataStd_Comment::GetID());
901 for (; aLabIter2.More(); aLabIter2.Next()) {
902 TDF_Label aFeatureLabel = aLabIter2.Value()->Label();
903 if (myObjs.IsBound(aFeatureLabel)) { // a new feature is inserted
904 FeaturePtr aFeature = myObjs.Find(aFeatureLabel);
905 if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature).get())
906 aComposites.push_back(aFeature);
907 updateResults(aFeature);
910 std::list<FeaturePtr>::iterator aComposite = aComposites.begin();
911 for(; aComposite != aComposites.end(); aComposite++) {
912 updateResults(*aComposite);
915 // check all features are checked: if not => it was removed
916 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
917 while (aFIter.More()) {
918 if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
919 && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
920 FeaturePtr aFeature = aFIter.Value();
921 // event: model is updated
922 //if (aFeature->isInHistory()) {
923 ModelAPI_EventCreator::get()->sendDeleted(aThis, ModelAPI_Feature::group());
925 // results of this feature must be redisplayed (hided)
926 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
927 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
928 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
929 // redisplay also removed feature (used for sketch and AISObject)
930 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
932 // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
933 myObjs.UnBind(aFIter.Key());
934 // reinitialize iterator because unbind may corrupt the previous order in the map
935 aFIter.Initialize(myObjs);
940 if (theUpdateReferences) {
941 synchronizeBackRefs();
944 myExecuteFeatures = false;
945 aLoop->activateFlushes(true);
947 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
948 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
949 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
950 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
951 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
952 myExecuteFeatures = true;
955 void Model_Document::synchronizeBackRefs()
957 std::shared_ptr<ModelAPI_Document> aThis =
958 Model_Application::getApplication()->getDocument(myID);
959 // keeps the concealed flags of result to catch the change and create created/deleted events
960 std::list<std::pair<ResultPtr, bool> > aConcealed;
961 // first cycle: erase all data about back-references
962 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myObjs);
963 for(; aFeatures.More(); aFeatures.Next()) {
964 FeaturePtr aFeature = aFeatures.Value();
965 std::shared_ptr<Model_Data> aFData =
966 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
968 aFData->eraseBackReferences();
970 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
971 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
972 for (; aRIter != aResults.cend(); aRIter++) {
973 std::shared_ptr<Model_Data> aResData =
974 std::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
976 aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
977 aResData->eraseBackReferences();
982 // second cycle: set new back-references: only features may have reference, iterate only them
983 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
984 for(aFeatures.Initialize(myObjs); aFeatures.More(); aFeatures.Next()) {
985 FeaturePtr aFeature = aFeatures.Value();
986 std::shared_ptr<Model_Data> aFData =
987 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
989 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
990 aFData->referencesToObjects(aRefs);
991 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRefsIter = aRefs.begin();
992 for(; aRefsIter != aRefs.end(); aRefsIter++) {
993 std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
994 for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
996 std::shared_ptr<Model_Data> aRefData =
997 std::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
998 aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
1004 std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
1005 for(; aCIter != aConcealed.end(); aCIter++) {
1006 if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
1007 if (aCIter->second) { // was concealed become not => creation event
1008 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
1009 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
1010 } else { // was not concealed become concealed => delete event
1011 ModelAPI_EventCreator::get()->sendDeleted(aThis, aCIter->first->groupName());
1012 // redisplay for the viewer (it must be disappeared also)
1013 static Events_ID EVENT_DISP =
1014 Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1015 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, EVENT_DISP);
1021 TDF_Label Model_Document::resultLabel(
1022 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex)
1024 const std::shared_ptr<Model_Data>& aData =
1025 std::dynamic_pointer_cast<Model_Data>(theFeatureData);
1026 return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
1029 void Model_Document::storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
1030 std::shared_ptr<ModelAPI_Result> theResult,
1031 const int theResultIndex)
1033 std::shared_ptr<ModelAPI_Document> aThis =
1034 Model_Application::getApplication()->getDocument(myID);
1035 theResult->setDoc(aThis);
1036 initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
1037 if (theResult->data()->name().empty()) { // if was not initialized, generate event and set a name
1038 theResult->data()->setName(theFeatureData->name());
1042 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1043 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1045 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1046 TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
1047 ObjectPtr anOldObject = object(aLab);
1048 std::shared_ptr<ModelAPI_ResultConstruction> aResult;
1050 aResult = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
1053 aResult = std::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
1054 storeResult(theFeatureData, aResult, theIndex);
1059 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1060 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1062 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1063 TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
1064 ObjectPtr anOldObject = object(aLab);
1065 std::shared_ptr<ModelAPI_ResultBody> aResult;
1067 aResult = std::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
1070 aResult = std::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
1071 storeResult(theFeatureData, aResult, theIndex);
1076 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1077 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1079 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1080 TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
1081 ObjectPtr anOldObject = object(aLab);
1082 std::shared_ptr<ModelAPI_ResultPart> aResult;
1084 aResult = std::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
1087 aResult = std::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
1088 storeResult(theFeatureData, aResult, theIndex);
1093 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1094 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1096 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1097 TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
1098 ObjectPtr anOldObject = object(aLab);
1099 std::shared_ptr<ModelAPI_ResultGroup> aResult;
1101 aResult = std::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
1104 aResult = std::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
1105 storeResult(theFeatureData, aResult, theIndex);
1110 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1111 const std::shared_ptr<ModelAPI_Result>& theResult)
1113 std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1115 TDF_Label aFeatureLab = aData->label().Father().Father().Father();
1116 return feature(aFeatureLab);
1118 return FeaturePtr();
1121 void Model_Document::updateResults(FeaturePtr theFeature)
1123 // for not persistent is will be done by parametric updater automatically
1124 //if (!theFeature->isPersistentResult()) return;
1125 // check the existing results and remove them if there is nothing on the label
1126 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
1127 while(aResIter != theFeature->results().cend()) {
1128 ResultPtr aBody = std::dynamic_pointer_cast<ModelAPI_Result>(*aResIter);
1130 if (!aBody->data()->isValid()) {
1131 // found a disappeared result => remove it
1132 theFeature->removeResult(aBody);
1133 // start iterate from beginning because iterator is corrupted by removing
1134 aResIter = theFeature->results().cbegin();
1140 // it may be on undo
1141 if (!theFeature->data() || !theFeature->data()->isValid())
1143 // check that results are presented on all labels
1144 int aResSize = theFeature->results().size();
1145 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
1146 for(; aLabIter.More(); aLabIter.Next()) {
1147 // here must be GUID of the feature
1148 int aResIndex = aLabIter.Value().Tag() - 1;
1150 if (aResSize <= aResIndex) {
1151 TDF_Label anArgLab = aLabIter.Value();
1152 Handle(TDataStd_Comment) aGroup;
1153 if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
1154 if (aGroup->Get() == ModelAPI_ResultBody::group().c_str()) {
1155 aNewBody = createBody(theFeature->data(), aResIndex);
1156 } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
1157 aNewBody = createPart(theFeature->data(), aResIndex);
1158 } else if (aGroup->Get() == ModelAPI_ResultConstruction::group().c_str()) {
1159 theFeature->execute(); // construction shapes are needed for sketch solver
1161 } else if (aGroup->Get() == ModelAPI_ResultGroup::group().c_str()) {
1162 aNewBody = createGroup(theFeature->data(), aResIndex);
1164 Events_Error::send(std::string("Unknown type of result is found in the document:") +
1165 TCollection_AsciiString(aGroup->Get()).ToCString());
1169 theFeature->setResult(aNewBody, aResIndex);
1175 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1177 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1180 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1182 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1185 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1187 myNamingNames[theName] = theLabel;
1190 TDF_Label Model_Document::findNamingName(std::string theName)
1192 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1193 if (aFind == myNamingNames.end())
1194 return TDF_Label(); // not found
1195 return aFind->second;
1198 ResultPtr Model_Document::findByName(const std::string theName)
1200 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator anObjIter(myObjs);
1201 for(; anObjIter.More(); anObjIter.Next()) {
1202 FeaturePtr& aFeature = anObjIter.ChangeValue();
1203 if (!aFeature) // may be on close
1205 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
1206 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
1207 for (; aRIter != aResults.cend(); aRIter++) {
1208 if (aRIter->get() && (*aRIter)->data() && (*aRIter)->data()->isValid() &&
1209 (*aRIter)->data()->name() == theName) {