1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #include "ModelAPI_Tools.h"
22 #include <ModelAPI_Session.h>
23 #include <ModelAPI_CompositeFeature.h>
24 #include <ModelAPI_Document.h>
25 #include <ModelAPI_Object.h>
26 #include <ModelAPI_AttributeDouble.h>
27 #include <ModelAPI_ResultCompSolid.h>
28 #include <ModelAPI_ResultParameter.h>
29 #include <ModelAPI_ResultPart.h>
30 #include <ModelAPI_AttributeDocRef.h>
31 #include <ModelAPI_Validator.h>
37 #include <Events_Loop.h>
38 #include <ModelAPI_Events.h>
40 #define RECURSE_TOP_LEVEL 50
42 //#define DEBUG_REMOVE_FEATURES
43 //#define DEBUG_REMOVE_FEATURES_RECURSE
44 //#define DEBUG_CYCLING_1550
46 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
48 std::string getFeatureInfo(FeaturePtr theFeature)
50 if (!theFeature.get())
52 //std::ostringstream aPtrStr;
53 //aPtrStr << "[" << theFeature.get() << "] ";
54 std::string aFeatureInfo = /*aPtrStr.str() + */theFeature->name();
55 CompositeFeaturePtr aComposite = ModelAPI_Tools::compositeOwner(theFeature);
56 if (aComposite.get()) {
57 aFeatureInfo = aFeatureInfo + "[in " + aComposite->name() + "]";
63 #ifdef DEBUG_REMOVE_FEATURES
64 void printMapInfo(const std::map<FeaturePtr, std::set<FeaturePtr> >& theMainList,
65 const std::string& thePrefix)
67 std::map<FeaturePtr, std::set<FeaturePtr> >::const_iterator aMainIt = theMainList.begin(),
68 aMainLast = theMainList.end();
70 for (; aMainIt != aMainLast; aMainIt++) {
71 FeaturePtr aMainListFeature = aMainIt->first;
72 std::set<FeaturePtr> aMainRefList = aMainIt->second;
73 std::set<FeaturePtr>::const_iterator anIt = aMainRefList.begin(), aLast = aMainRefList.end();
74 std::string aRefsInfo;
75 for (; anIt != aLast; anIt++) {
76 aRefsInfo += (*anIt)->name().c_str();
80 if (!aRefsInfo.empty()) {
81 anInfo = anInfo + aMainListFeature->name().c_str() + ": " + aRefsInfo + "\n";
84 std::cout << thePrefix.c_str() << " [feature: references to]: \n" << anInfo.c_str() << std::endl;
87 void printListInfo(const std::set<FeaturePtr>& theMainList,
88 const std::string& thePrefix)
90 std::set<FeaturePtr>::const_iterator aMainIt = theMainList.begin(),
91 aMainLast = theMainList.end();
93 for (; aMainIt != aMainLast; aMainIt++) {
94 FeaturePtr aRefFeature = *aMainIt;
95 anInfo += aRefFeature->name().c_str();
96 if (aMainIt != aMainLast)
99 std::cout << thePrefix.c_str() << ": " << anInfo.c_str() << std::endl;
103 namespace ModelAPI_Tools {
105 std::shared_ptr<GeomAPI_Shape> shape(const ResultPtr& theResult)
107 return theResult->shape();
110 const char* toString(ModelAPI_ExecState theExecState)
112 switch (theExecState) {
113 case ModelAPI_StateDone: return "Done";
114 case ModelAPI_StateMustBeUpdated: return "Must be updated";
115 case ModelAPI_StateExecFailed: return "Execution failed";
116 case ModelAPI_StateInvalidArgument: return "Invalid argument";
117 case ModelAPI_StateNothing: return "Empty state";
118 default: return "Unknown ExecState.";
122 std::string getFeatureError(const FeaturePtr& theFeature)
125 if (!theFeature.get() || !theFeature->data()->isValid() || theFeature->isAction())
128 // to be removed later, this error should be got from the feature
129 if (theFeature->data()->execState() == ModelAPI_StateDone ||
130 theFeature->data()->execState() == ModelAPI_StateMustBeUpdated)
133 // set error indication
134 anError = theFeature->error();
135 if (anError.empty()) {
136 bool isDone = ( theFeature->data()->execState() == ModelAPI_StateDone
137 || theFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
139 anError = toString(theFeature->data()->execState());
140 // If the feature is Composite and error is StateInvalidArgument,
141 // error text should include error of first invalid sub-feature. Otherwise
142 // it is not clear what is the reason of the invalid argument.
143 if (theFeature->data()->execState() == ModelAPI_StateInvalidArgument) {
144 CompositeFeaturePtr aComposite =
145 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
147 for (int i = 0, aSize = aComposite->numberOfSubs(); i < aSize; i++) {
148 FeaturePtr aSubFeature = aComposite->subFeature(i);
149 std::string aSubFeatureError = getFeatureError(aSubFeature);
150 if (!aSubFeatureError.empty()) {
151 anError = anError + " in " + aSubFeature->getKind() + ".\n" + aSubFeatureError;
163 ObjectPtr objectByName(const DocumentPtr& theDocument, const std::string& theGroup,
164 const std::string& theName)
166 for (int anIndex = 0; anIndex < theDocument->size(theGroup); ++anIndex) {
167 ObjectPtr anObject = theDocument->object(theGroup, anIndex);
168 if (anObject->data()->name() == theName)
175 bool findVariable(const DocumentPtr& theDocument, FeaturePtr theSearcher,
176 const std::string& theName, double& outValue, ResultParameterPtr& theParam)
178 ObjectPtr aParamObj = objectByName(theDocument, ModelAPI_ResultParameter::group(), theName);
179 theParam = std::dynamic_pointer_cast<ModelAPI_ResultParameter>(aParamObj);
182 // avoid usage of parameters created later than the initial parameter
184 if (theSearcher.get()) {
185 FeaturePtr aParamFeat = theDocument->feature(theParam);
186 if (aParamFeat == theSearcher || theDocument->isLater(aParamFeat, theSearcher))
189 AttributeDoublePtr aValueAttribute = theParam->data()->real(ModelAPI_ResultParameter::VALUE());
190 outValue = aValueAttribute->value();
194 bool findVariable(FeaturePtr theSearcher, const std::string& theName, double& outValue,
195 ResultParameterPtr& theParam, const DocumentPtr& theDocument)
197 SessionPtr aSession = ModelAPI_Session::get();
198 std::list<DocumentPtr> aDocList;
199 DocumentPtr aDocument = theDocument.get() ? theDocument : aSession->activeDocument();
200 if (findVariable(aDocument, theSearcher, theName, outValue, theParam))
202 DocumentPtr aRootDocument = aSession->moduleDocument();
203 if (aDocument != aRootDocument) {
204 // any parameters in PartSet is okindependently on the Part position (issu #1504)
205 if (findVariable(aRootDocument, FeaturePtr(), theName, outValue, theParam))
211 ResultPtr findPartResult(const DocumentPtr& theMain, const DocumentPtr& theSub)
213 // to optimize and avoid of crash on partset document close
214 // (don't touch the sub-document structure)
215 if (theMain != theSub) {
216 for (int a = theMain->size(ModelAPI_ResultPart::group()) - 1; a >= 0; a--) {
217 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(
218 theMain->object(ModelAPI_ResultPart::group(), a));
219 if (aPart && aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->value() == theSub) {
227 FeaturePtr findPartFeature(const DocumentPtr& theMain, const DocumentPtr& theSub)
229 // to optimize and avoid of crash on partset document close
230 // (don't touch the sub-document structure)
231 if (theMain != theSub) {
232 // iteration from top to bottom to avoid finding the movement documents before the original
233 int aSize = theMain->size(ModelAPI_Feature::group());
234 for (int a = 0; a < aSize; a++) {
235 FeaturePtr aPartFeat = std::dynamic_pointer_cast<ModelAPI_Feature>(
236 theMain->object(ModelAPI_Feature::group(), a));
237 if (aPartFeat.get()) {
238 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aPartFeat->results();
239 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
240 for(; aRes != aResList.end(); aRes++) {
241 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes);
243 if (aPart->isActivated() && aPart->partDoc() == theSub)
245 } else break; // if the first is not Part, others are also not
253 CompositeFeaturePtr compositeOwner(const FeaturePtr& theFeature)
255 if (theFeature.get() && theFeature->data() && theFeature->data()->isValid()) {
256 const std::set<std::shared_ptr<ModelAPI_Attribute> >& aRefs = theFeature->data()->refsToMe();
257 std::set<std::shared_ptr<ModelAPI_Attribute> >::const_iterator aRefIter = aRefs.begin();
258 for(; aRefIter != aRefs.end(); aRefIter++) {
259 CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>
260 ((*aRefIter)->owner());
261 if (aComp.get() && aComp->data()->isValid() && aComp->isSub(theFeature))
265 return CompositeFeaturePtr(); // not found
268 ResultCompSolidPtr compSolidOwner(const ResultPtr& theSub)
271 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theSub);
273 FeaturePtr aFeatureOwner = aBody->document()->feature(aBody);
274 if (aFeatureOwner.get()) {
275 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aResIter =
276 aFeatureOwner->results().cbegin();
277 for(; aResIter != aFeatureOwner->results().cend(); aResIter++) {
278 ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aResIter);
279 if (aComp && aComp->isSub(aBody, anIndex))
284 return ResultCompSolidPtr(); // not found
287 int compSolidIndex(const ResultPtr& theSub)
290 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theSub);
292 FeaturePtr aFeatureOwner = aBody->document()->feature(aBody);
293 if (aFeatureOwner.get()) {
294 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aResIter =
295 aFeatureOwner->results().cbegin();
296 for(; aResIter != aFeatureOwner->results().cend(); aResIter++) {
297 ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aResIter);
298 if (aComp && aComp->isSub(aBody, anIndex))
303 return anIndex; // not found
306 bool hasSubResults(const ResultPtr& theResult)
308 ResultCompSolidPtr aCompSolid = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(theResult);
309 return aCompSolid.get() && aCompSolid->numberOfSubs() > 0;
312 void allResults(const FeaturePtr& theFeature, std::list<ResultPtr>& theResults)
314 if (!theFeature.get()) // safety: for empty feature no results
316 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
317 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
318 for (; aRIter != aResults.cend(); aRIter++) {
319 theResults.push_back(*aRIter);
320 // iterate sub-bodies of compsolid
321 ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRIter);
323 int aNumSub = aComp->numberOfSubs();
324 for(int a = 0; a < aNumSub; a++) {
325 theResults.push_back(aComp->subResult(a));
331 //******************************************************************
332 bool allDocumentsActivated(std::string& theNotActivatedNames)
334 theNotActivatedNames = "";
335 bool anAllPartActivated = true;
337 DocumentPtr aRootDoc = ModelAPI_Session::get()->moduleDocument();
338 int aSize = aRootDoc->size(ModelAPI_ResultPart::group());
339 for (int i = 0; i < aSize; i++) {
340 ObjectPtr aObject = aRootDoc->object(ModelAPI_ResultPart::group(), i);
341 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(aObject);
342 if (!aPart->isActivated()) {
343 anAllPartActivated = false;
344 if (!theNotActivatedNames.empty())
345 theNotActivatedNames += ", ";
346 theNotActivatedNames += aObject->data()->name().c_str();
349 return anAllPartActivated;
352 bool removeFeaturesAndReferences(const std::set<FeaturePtr>& theFeatures,
353 const bool theFlushRedisplay,
354 const bool theUseComposite,
355 const bool theUseRecursion)
357 #ifdef DEBUG_REMOVE_FEATURES
358 printListInfo(theFeatures, "selection: ");
361 std::map<FeaturePtr, std::set<FeaturePtr> > aReferences;
362 ModelAPI_Tools::findAllReferences(theFeatures, aReferences, theUseComposite, theUseRecursion);
363 #ifdef DEBUG_REMOVE_FEATURES
364 printMapInfo(aReferences, "allDependencies: ");
367 std::set<FeaturePtr> aFeaturesRefsTo;
368 ModelAPI_Tools::findRefsToFeatures(theFeatures, aReferences, aFeaturesRefsTo);
369 #ifdef DEBUG_REMOVE_FEATURES
370 printListInfo(aFeaturesRefsTo, "references: ");
373 std::set<FeaturePtr> aFeatures = theFeatures;
374 if (!aFeaturesRefsTo.empty())
375 aFeatures.insert(aFeaturesRefsTo.begin(), aFeaturesRefsTo.end());
376 #ifdef DEBUG_REMOVE_FEATURES
377 printListInfo(aFeatures, "removeFeatures: ");
380 return ModelAPI_Tools::removeFeatures(aFeatures, false);
383 //***********************************************************************
384 bool removeFeatures(const std::set<FeaturePtr>& theFeatures,
385 const bool theFlushRedisplay)
388 std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
389 aLast = theFeatures.end();
390 for (; anIt != aLast; anIt++) {
391 FeaturePtr aFeature = *anIt;
392 if (aFeature.get()) {
393 DocumentPtr aDoc = aFeature->document();
394 // flush REDISPLAY signal after remove feature
395 aDoc->removeFeature(aFeature);
399 if (isDone && theFlushRedisplay) {
400 // the redisplay signal should be flushed in order to erase
401 // the feature presentation in the viewer
402 // if should be done after removeFeature() of document
403 Events_Loop::loop()->flush(Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY));
408 //***********************************************************************
409 // Fills the references list by all references of the feature from the references map.
410 // This is a recusive method to find references by next found feature in the map of references.
411 // \param theFeature a feature to find references
412 // \param theReferencesMap a map of references
413 // \param theReferences an out container of references
414 void addRefsToFeature(const FeaturePtr& theFeature,
415 const std::map<FeaturePtr, std::set<FeaturePtr> >& theReferencesMap,
416 std::map<FeaturePtr, std::set<FeaturePtr> >& theProcessedReferences,
418 std::set<FeaturePtr>& theReferences)
420 if (theRecLevel > RECURSE_TOP_LEVEL)
424 // if the feature is already processed, get the ready references from the map
425 if (theProcessedReferences.find(theFeature) != theProcessedReferences.end()) {
426 std::set<FeaturePtr> aReferences = theProcessedReferences.at(theFeature);
427 theReferences.insert(aReferences.begin(), aReferences.end());
431 if (theReferencesMap.find(theFeature) == theReferencesMap.end())
432 return; // this feature is not in the selection list, so exists without references to it
433 std::set<FeaturePtr> aMainReferences = theReferencesMap.at(theFeature);
435 std::set<FeaturePtr>::const_iterator anIt = aMainReferences.begin(),
436 aLast = aMainReferences.end();
437 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
438 std::string aSpacing;
439 for (int i = 0; i < theRecLevel; i++)
440 aSpacing.append(" ");
443 for (; anIt != aLast; anIt++) {
444 FeaturePtr aRefFeature = *anIt;
445 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
446 std::cout << aSpacing << " Ref: " << getFeatureInfo(aRefFeature) << std::endl;
448 if (theReferences.find(aRefFeature) == theReferences.end())
449 theReferences.insert(aRefFeature);
450 addRefsToFeature(aRefFeature, theReferencesMap, theProcessedReferences,
451 theRecLevel, theReferences);
455 // For each feature from the feature list it searches references to the feature and append them
456 // to the references map. This is a recusive method.
457 // \param theFeature a feature to find references
458 // \param theReferencesMap a map of references
459 // \param theReferences an out container of references
460 void findReferences(const std::set<FeaturePtr>& theFeatures,
461 std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
462 const bool theUseComposite, const bool theUseRecursion, int theRecLevel)
464 if (theRecLevel > RECURSE_TOP_LEVEL)
467 std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
468 aLast = theFeatures.end();
469 for (; anIt != aLast; anIt++) {
470 FeaturePtr aFeature = *anIt;
471 if (aFeature.get() && theReferences.find(aFeature) == theReferences.end()) {
472 DocumentPtr aSelFeatureDoc = aFeature->document();
473 std::set<FeaturePtr> aSelRefFeatures;
474 aSelFeatureDoc->refsToFeature(aFeature, aSelRefFeatures, false/*do not emit signals*/);
475 if (theUseComposite) { // do not filter selection
476 theReferences[aFeature] = aSelRefFeatures;
478 else { // filter references to skip composition features of the current feature
479 std::set<FeaturePtr> aFilteredFeatures;
480 std::set<FeaturePtr>::const_iterator anIt = aSelRefFeatures.begin(),
481 aLast = aSelRefFeatures.end();
482 for (; anIt != aLast; anIt++) {
483 FeaturePtr aCFeature = *anIt;
484 CompositeFeaturePtr aComposite =
485 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCFeature);
486 if (aComposite.get() && aComposite->isSub(aFeature))
487 continue; /// composite of the current feature should be skipped
488 aFilteredFeatures.insert(aCFeature);
490 theReferences[aFeature] = aFilteredFeatures;
492 if (theUseRecursion) {
493 #ifdef DEBUG_CYCLING_1550
494 findReferences(aSelRefFeatures, theReferences, theUseComposite,
495 theUseRecursion, theRecLevel);
497 findReferences(theReferences[aFeature], theReferences, theUseComposite, theUseRecursion,
505 void findAllReferences(const std::set<FeaturePtr>& theFeatures,
506 std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
507 const bool theUseComposite,
508 const bool theUseRecursion)
510 // For dependencies, find main_list:
511 // sk_1(ext_1, vertex_1)
512 // ext_1(bool_1, sk_3)
517 // Information: bool_1 is not selected, ext_2(bool_2) exists
518 // find all referenced features
519 std::map<FeaturePtr, std::set<FeaturePtr> > aMainList;
521 findReferences(theFeatures, aMainList, theUseComposite, theUseRecursion, aRecLevel);
523 #ifdef DEBUG_REMOVE_FEATURES
524 printMapInfo(aMainList, "firstDependencies");
526 // find all dependencies for each object:
527 // sk_1(ext_1, vertex_1) + (sk_3, bool_1)
528 // ext_1(bool_1, sk_3)
530 // sk_2(ext_2) + (bool_1)
533 std::map<FeaturePtr, std::set<FeaturePtr> >::const_iterator aMainIt = aMainList.begin(),
534 aMainLast = aMainList.end();
535 for (; aMainIt != aMainLast; aMainIt++) {
536 FeaturePtr aMainListFeature = aMainIt->first;
538 //std::string aName = aMainListFeature->name();
539 std::set<FeaturePtr> aMainRefList = aMainIt->second;
541 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
543 int n = sprintf(aBuf, "%d", aMainRefList.size());
544 std::string aSize(aBuf);
545 std::cout << "_findAllReferences for the Feature: " << getFeatureInfo(aMainListFeature)
546 << ", references size = " << aSize << std::endl;
548 std::set<FeaturePtr>::const_iterator anIt = aMainRefList.begin(),
549 aLast = aMainRefList.end();
550 std::set<FeaturePtr> aResultRefList;
551 aResultRefList.insert(aMainRefList.begin(), aMainRefList.end());
552 for (; anIt != aLast; anIt++) {
553 FeaturePtr aFeature = *anIt;
555 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
556 std::cout << " Ref: " << getFeatureInfo(aFeature) << std::endl;
559 addRefsToFeature(aFeature, aMainList, theReferences,
560 aRecLevel, aResultRefList/*aMainRefList*/);
562 theReferences[aMainListFeature] = aResultRefList;
564 #ifdef DEBUG_REMOVE_FEATURES_RECURSE
565 std::cout << std::endl;
568 #ifdef DEBUG_REMOVE_FEATURES
569 printMapInfo(theReferences, "allDependencies");
573 void findRefsToFeatures(const std::set<FeaturePtr>& theFeatures,
574 const std::map<FeaturePtr, std::set<FeaturePtr> >& theReferences,
575 std::set<FeaturePtr>& theFeaturesRefsTo)
577 std::set<FeaturePtr>::const_iterator anIt = theFeatures.begin(),
578 aLast = theFeatures.end();
579 for (; anIt != aLast; anIt++) {
580 FeaturePtr aFeature = *anIt;
581 if (theReferences.find(aFeature) == theReferences.end())
583 std::set<FeaturePtr> aRefList = theReferences.at(aFeature);
584 std::set<FeaturePtr>::const_iterator aRefIt = aRefList.begin(), aRefLast = aRefList.end();
585 for (; aRefIt != aRefLast; aRefIt++) {
586 FeaturePtr aRefFeature = *aRefIt;
587 CompositeFeaturePtr aComposite =
588 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aRefFeature);
589 if (aComposite.get() && aComposite->isSub(aFeature))
590 continue; /// composite of the current feature should not be removed
592 if (theFeatures.find(aRefFeature) == theFeatures.end() && // it is not selected
593 theFeaturesRefsTo.find(aRefFeature) == theFeaturesRefsTo.end()) // it is not added
594 theFeaturesRefsTo.insert(aRefFeature);
599 void getConcealedResults(const FeaturePtr& theFeature,
600 std::list<std::shared_ptr<ModelAPI_Result> >& theResults)
602 SessionPtr aSession = ModelAPI_Session::get();
604 std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > > aRefs;
605 theFeature->data()->referencesToObjects(aRefs);
606 std::list<std::pair<std::string, std::list<ObjectPtr> > >::const_iterator
607 anIt = aRefs.begin(), aLast = aRefs.end();
608 std::set<ResultPtr> alreadyThere; // to avoid duplications
609 for (; anIt != aLast; anIt++) {
610 if (!aSession->validators()->isConcealed(theFeature->getKind(), anIt->first))
611 continue; // use only concealed attributes
612 std::list<ObjectPtr> anObjects = (*anIt).second;
613 std::list<ObjectPtr>::const_iterator anOIt = anObjects.begin(), anOLast = anObjects.end();
614 for (; anOIt != anOLast; anOIt++) {
615 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(*anOIt);
616 if (aResult && aResult->isConcealed()) {
617 if (alreadyThere.find(aResult) == alreadyThere.end()) // issue 1712, avoid duplicates
618 alreadyThere.insert(aResult);
620 theResults.push_back(aResult);
626 std::pair<std::string, bool> getDefaultName(
627 const std::shared_ptr<ModelAPI_Result>& theResult,
628 const int theResultIndex)
630 typedef std::list< std::pair < std::string, std::list<ObjectPtr> > > ListOfReferences;
632 SessionPtr aSession = ModelAPI_Session::get();
633 FeaturePtr anOwner = ModelAPI_Feature::feature(theResult->data()->owner());
635 ResultCompSolidPtr aCompSolidRes = compSolidOwner(theResult);
637 // names of sub-solids in CompSolid should be default (for example,
638 // result of boolean operation 'Boolean_1_1' is a CompSolid which is renamed to 'MyBOOL',
639 // however, sub-elements of 'MyBOOL' should be named 'Boolean_1_1_1', 'Boolean_1_1_2' etc.)
640 std::ostringstream aDefaultName;
641 aDefaultName << anOwner->name();
642 // compute default name of CompSolid (name of feature + index of CompSolid's result)
643 int aCompSolidResultIndex = 0;
644 const std::list<ResultPtr>& aResults = anOwner->results();
645 for (std::list<ResultPtr>::const_iterator anIt = aResults.begin();
646 anIt != aResults.end(); ++anIt, ++aCompSolidResultIndex)
647 if (aCompSolidRes == *anIt)
649 aDefaultName << "_" << (aCompSolidResultIndex + 1) << "_" << (theResultIndex + 1);
650 return std::pair<std::string, bool>(aDefaultName.str(), false);
653 DataPtr aData = anOwner->data();
655 ListOfReferences aReferences;
656 aData->referencesToObjects(aReferences);
658 // find first result with user-defined name
659 ListOfReferences::const_iterator aFoundRef = aReferences.end();
660 for (ListOfReferences::const_iterator aRefIt = aReferences.begin();
661 aRefIt != aReferences.end(); ++aRefIt) {
662 bool isConcealed = aSession->validators()->isConcealed(anOwner->getKind(), aRefIt->first);
663 bool isMainArg = isConcealed &&
664 aSession->validators()->isMainArgument(anOwner->getKind(), aRefIt->first);
666 // check the referred object is a Body
667 // (for example, ExtrusionCut has a sketch as a first attribute which is concealing)
668 bool isBody = aRefIt->second.size() > 1 || (aRefIt->second.size() == 1 &&
669 aRefIt->second.front()->groupName() == ModelAPI_ResultBody::group());
670 if (isBody && (isMainArg || aFoundRef == aReferences.end() ||
671 aData->isPrecedingAttribute(aRefIt->first, aFoundRef->first)))
679 // find an object which is concealed by theResult
680 if (aFoundRef != aReferences.end() && !aFoundRef->second.empty()) {
681 // store number of references for each object
682 std::map<ResultPtr, int> aNbRefToObject;
683 // search the object by result index
684 std::list<ObjectPtr>::const_iterator anObjIt = aFoundRef->second.begin();
685 int aResultIndex = theResultIndex;
686 while (--aResultIndex >= 0) {
687 ResultPtr aCurRes = std::dynamic_pointer_cast<ModelAPI_Result>(*anObjIt);
688 ResultCompSolidPtr aParentCompSolid = ModelAPI_Tools::compSolidOwner(aCurRes);
689 if (aParentCompSolid)
690 aCurRes = aParentCompSolid;
691 if (aNbRefToObject.find(aCurRes) == aNbRefToObject.end())
692 aNbRefToObject[aCurRes] = 1;
694 aNbRefToObject[aCurRes] += 1;
697 if (anObjIt == aFoundRef->second.end()) {
698 anObjIt = aFoundRef->second.begin();
702 // check the result is a Body
703 if ((*anObjIt)->groupName() == ModelAPI_ResultBody::group()) {
704 // check the result is part of CompSolid
705 ResultPtr anObjRes = std::dynamic_pointer_cast<ModelAPI_Result>(*anObjIt);
706 ResultCompSolidPtr aParentCompSolid = ModelAPI_Tools::compSolidOwner(anObjRes);
707 if (aParentCompSolid)
708 anObjRes = aParentCompSolid;
710 // return name of reference result only if it has been renamed by the user,
711 // in other case compose a default name
712 if (anObjRes->data()->hasUserDefinedName()) {
713 std::stringstream aName;
714 aName << anObjRes->data()->name();
715 std::map<ResultPtr, int>::iterator aFound = aNbRefToObject.find(anObjRes);
716 if (aFound != aNbRefToObject.end()) {
717 // to generate unique name, add suffix if there are several results
718 // referring to the same shape
719 aName << "_" << aFound->second + 1;
721 return std::pair<std::string, bool>(aName.str(), true);
726 // compose default name by the name of the feature and the index of result
727 std::stringstream aDefaultName;
728 aDefaultName << anOwner->name();
729 // if there are several results (issue #899: any number of result),
730 // add unique prefix starting from second
731 if (theResultIndex > 0 || theResult->groupName() == ModelAPI_ResultBody::group())
732 aDefaultName << "_" << theResultIndex + 1;
733 return std::pair<std::string, bool>(aDefaultName.str(), false);
736 } // namespace ModelAPI_Tools