1 // Copyright (C) 2016-20xx CEA/DEN, EDF R&D -->
3 // File: ModelHighAPI_Dumper.cpp
4 // Created: 1 August 2016
5 // Author: Artem ZHIDKOV
7 //--------------------------------------------------------------------------------------
8 #include "ModelHighAPI_Dumper.h"
10 #include <GeomAPI_Pnt.h>
11 #include <GeomAPI_Dir.h>
13 #include <GeomDataAPI_Dir.h>
14 #include <GeomDataAPI_Point.h>
15 #include <GeomDataAPI_Point2D.h>
17 #include <ModelAPI_AttributeBoolean.h>
18 #include <ModelAPI_AttributeDouble.h>
19 #include <ModelAPI_AttributeInteger.h>
20 #include <ModelAPI_AttributeRefAttr.h>
21 #include <ModelAPI_AttributeRefAttrList.h>
22 #include <ModelAPI_AttributeReference.h>
23 #include <ModelAPI_AttributeRefList.h>
24 #include <ModelAPI_AttributeSelection.h>
25 #include <ModelAPI_AttributeSelectionList.h>
26 #include <ModelAPI_AttributeString.h>
27 #include <ModelAPI_CompositeFeature.h>
28 #include <ModelAPI_Document.h>
29 #include <ModelAPI_Entity.h>
30 #include <ModelAPI_Feature.h>
31 #include <ModelAPI_Result.h>
32 #include <ModelAPI_ResultPart.h>
34 #include <PartSetPlugin_Part.h>
36 #include <OSD_OpenFile.hxx>
40 #define DUMP_USER_DEFINED_NAMES
42 static int gCompositeStackDepth = 0;
44 ModelHighAPI_Dumper* ModelHighAPI_Dumper::mySelf = 0;
46 ModelHighAPI_Dumper::ModelHighAPI_Dumper()
51 void ModelHighAPI_Dumper::setInstance(ModelHighAPI_Dumper* theDumper)
57 ModelHighAPI_Dumper* ModelHighAPI_Dumper::getInstance()
62 void ModelHighAPI_Dumper::clear(bool bufferOnly)
65 myDumpBuffer << std::setprecision(16);
71 myFullDump << std::setprecision(16);
75 myFeatureCount.clear();
76 myLastEntityWithName = EntityPtr();
80 void ModelHighAPI_Dumper::clearNotDumped()
82 myNotDumpedEntities.clear();
85 const std::string& ModelHighAPI_Dumper::name(const EntityPtr& theEntity, bool theSaveNotDumped)
87 EntityNameMap::const_iterator aFound = myNames.find(theEntity);
88 if (aFound != myNames.end())
89 return aFound->second.first;
91 // entity is not found, store it
93 bool isUserDefined = false;
94 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
97 aName = aFeature->name();
98 const std::string& aKind = aFeature->getKind();
99 DocumentPtr aDoc = aFeature->document();
100 int& aNbFeatures = myFeatureCount[aDoc][aKind];
102 size_t anIndex = aName.find(aKind);
103 if (anIndex == 0 && aName[aKind.length()] == '_') { // name starts with "FeatureKind_"
104 std::string anIdStr = aName.substr(aKind.length() + 1, std::string::npos);
105 int anId = std::stoi(anIdStr);
107 // Check number of already registered objects of such kind. Index of current object
108 // should be the same to identify feature's name as automatically generated.
109 if (aNbFeatures + 1 == anId) {
110 isUserDefined = false;
111 //aNbFeatures = anId - 1;
118 myNames[theEntity] = std::pair<std::string, bool>(aName, isUserDefined);
119 if (theSaveNotDumped)
120 myNotDumpedEntities.insert(theEntity);
121 return myNames[theEntity].first;
124 const std::string& ModelHighAPI_Dumper::parentName(const FeaturePtr& theEntity)
126 const std::set<AttributePtr>& aRefs = theEntity->data()->refsToMe();
127 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin();
128 for (; aRefIt != aRefs.end(); ++aRefIt) {
129 CompositeFeaturePtr anOwner = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(
130 ModelAPI_Feature::feature((*aRefIt)->owner()));
132 return name(anOwner);
135 static const std::string DUMMY;
139 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc,
140 const std::string& theFileName)
142 // dump top level document feature
143 static const std::string aDocName("partSet");
144 myNames[theDoc] = std::pair<std::string, bool>(aDocName, false);
145 *this << aDocName << " = model.moduleDocument()" << std::endl;
147 // dump subfeatures and store result to file
148 return process(theDoc) && exportTo(theFileName);
151 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc)
154 std::list<FeaturePtr> aFeatures = theDoc->allFeatures();
155 std::list<FeaturePtr>::const_iterator aFeatIt = aFeatures.begin();
156 // firstly, dump all parameters
157 for (; aFeatIt != aFeatures.end(); ++ aFeatIt)
158 dumpParameter(*aFeatIt);
159 // dump all other features
160 for (aFeatIt = aFeatures.begin(); aFeatIt != aFeatures.end(); ++aFeatIt) {
161 CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*aFeatIt);
162 if (aCompFeat) // iteratively process composite features
163 isOk = process(aCompFeat) && isOk;
164 else if (!isDumped(*aFeatIt)) // dump common feature
165 dumpFeature(*aFeatIt);
170 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite, bool isForce)
172 // increase composite features stack
173 ++gCompositeStackDepth;
174 // dump composite itself
175 if (!isDumped(theComposite) || isForce)
176 dumpFeature(theComposite, isForce);
178 // sub-part is processed independently, because it provides separate document
179 if (theComposite->getKind() == PartSetPlugin_Part::ID()) {
180 // decrease composite features stack because we run into separate document
181 --gCompositeStackDepth;
183 ResultPartPtr aPartResult =
184 std::dynamic_pointer_cast<ModelAPI_ResultPart>(theComposite->lastResult());
187 DocumentPtr aSubDoc = aPartResult->partDoc();
188 // set name of document
189 const std::string& aPartName = myNames[theComposite].first;
190 std::string aDocName = aPartName + "_doc";
191 myNames[aSubDoc] = std::pair<std::string, bool>(aDocName, false);
193 // dump document in a separate line
194 *this << aDocName << " = " << aPartName << ".document()" << std::endl;
195 // dump features in the document
196 return process(aSubDoc);
200 bool isOk = processSubs(theComposite);
201 // decrease composite features stack
202 --gCompositeStackDepth;
207 bool ModelHighAPI_Dumper::processSubs(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
211 // dump all sub-features;
212 int aNbSubs = theComposite->numberOfSubs();
213 for (int anIndex = 0; anIndex < aNbSubs; ++anIndex) {
214 FeaturePtr aFeature = theComposite->subFeature(anIndex);
215 if (isDumped(aFeature))
218 CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
219 if (aCompFeat) // iteratively process composite features
220 isOk = process(aCompFeat) && isOk;
222 dumpFeature(aFeature, true);
225 // It is necessary for the sketch to create its result when complete (command "model.do()").
226 // This option is set by flat theDumpModelDo.
227 // However, nested sketches are rebuilt by parent feature, so, they do not need
228 // explicit call of "model.do()". This will be controlled by the depth of the stack.
229 if (theDumpModelDo && gCompositeStackDepth <= 1)
230 *this << "model.do()" << std::endl;
234 bool ModelHighAPI_Dumper::exportTo(const std::string& theFileName)
237 OSD_OpenStream(aFile, theFileName.c_str(), std::ofstream::out);
238 if (!aFile.is_open())
242 for (ModulesMap::const_iterator aModIt = myModules.begin();
243 aModIt != myModules.end(); ++aModIt) {
244 aFile << "from " << aModIt->first << " import ";
245 if (aModIt->second.empty() ||
246 aModIt->second.find(std::string()) != aModIt->second.end())
247 aFile << "*"; // import whole module
249 // import specific features
250 std::set<std::string>::const_iterator anObjIt = aModIt->second.begin();
252 for (++anObjIt; anObjIt != aModIt->second.end(); ++anObjIt)
253 aFile << ", " << *anObjIt;
257 if (!myModules.empty())
260 aFile << "import model" << std::endl << std::endl;
261 aFile << "model.begin()" << std::endl;
263 // dump collected data
264 aFile << myFullDump.str();
267 aFile << "model.end()" << std::endl;
275 void ModelHighAPI_Dumper::importModule(const std::string& theModuleName,
276 const std::string& theObject)
278 myModules[theModuleName].insert(theObject);
281 void ModelHighAPI_Dumper::dumpEntitySetName()
283 if (!myLastEntityWithName)
286 #ifdef DUMP_USER_DEFINED_NAMES
287 const std::string& aName = name(myLastEntityWithName);
288 myDumpBuffer << aName;
289 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(myLastEntityWithName);
291 myDumpBuffer << ".feature()";
292 myDumpBuffer << ".data().setName(\"" << aName << "\")" << std::endl;
294 myNames[myLastEntityWithName].second = false; // don't dump "setName" for the entity twice
295 myLastEntityWithName = EntityPtr();
298 bool ModelHighAPI_Dumper::isDumped(const EntityPtr& theEntity) const
300 EntityNameMap::const_iterator aFound = myNames.find(theEntity);
301 return aFound != myNames.end();
304 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char theChar)
306 myDumpBuffer << theChar;
310 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char* theString)
312 myDumpBuffer << theString;
316 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::string& theString)
318 myDumpBuffer << theString;
322 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const bool theValue)
324 myDumpBuffer << (theValue ? "True" : "False");
328 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const int theValue)
330 myDumpBuffer << theValue;
334 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const double theValue)
336 myDumpBuffer << theValue;
340 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint)
342 importModule("GeomAPI", "GeomAPI_Pnt");
343 myDumpBuffer << "GeomAPI_Pnt(" << thePoint->x() << ", "
344 << thePoint->y() << ", " << thePoint->z() << ")";
348 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir)
350 importModule("GeomAPI", "GeomAPI_Dir");
351 myDumpBuffer << "GeomAPI_Dir(" << theDir->x() << ", "
352 << theDir->y() << ", " << theDir->z() << ")";
356 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
357 const std::shared_ptr<GeomDataAPI_Dir>& theDir)
359 myDumpBuffer << theDir->x() << ", " << theDir->y() << ", " << theDir->z();
363 static void dumpArray(std::ostringstream& theOutput, int theSize,
364 double* theValues, std::string* theTexts)
366 for (int i = 0; i < theSize; ++i) {
369 if (theTexts[i].empty())
370 theOutput << theValues[i];
372 theOutput << "\"" << theTexts[i] << "\"";
376 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
377 const std::shared_ptr<GeomDataAPI_Point>& thePoint)
379 static const int aSize = 3;
380 double aValues[aSize] = {thePoint->x(), thePoint->y(), thePoint->z()};
381 std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY(), thePoint->textZ()};
382 dumpArray(myDumpBuffer, aSize, aValues, aTexts);
386 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
387 const std::shared_ptr<GeomDataAPI_Point2D>& thePoint)
389 static const int aSize = 2;
390 double aValues[aSize] = {thePoint->x(), thePoint->y()};
391 std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY()};
392 dumpArray(myDumpBuffer, aSize, aValues, aTexts);
396 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
397 const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool)
399 myDumpBuffer << (theAttrBool->value() ? "True" : "False");
403 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
404 const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt)
406 std::string aText = theAttrInt->text();
408 myDumpBuffer << theAttrInt->value();
410 myDumpBuffer << "\"" << aText << "\"";
414 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
415 const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal)
417 std::string aText = theAttrReal->text();
419 myDumpBuffer << theAttrReal->value();
421 myDumpBuffer << "\"" << aText << "\"";
425 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
426 const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr)
428 myDumpBuffer << "\"" << theAttrStr->value() << "\"";
432 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FeaturePtr& theEntity)
434 myDumpBuffer << name(theEntity);
435 if (myNames[theEntity].second)
436 myLastEntityWithName = theEntity;
437 myNotDumpedEntities.erase(theEntity);
441 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ResultPtr& theResult)
443 FeaturePtr aFeature = ModelAPI_Feature::feature(theResult);
445 std::list<ResultPtr> aResults = aFeature->results();
446 for(std::list<ResultPtr>::const_iterator anIt = aResults.cbegin(); anIt != aResults.cend(); ++anIt, ++anIndex) {
447 if(theResult->isSame(*anIt)) {
451 myDumpBuffer << name(aFeature) << ".result()[" << anIndex << "]";
455 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ObjectPtr& theObject)
457 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
459 myDumpBuffer << name(aFeature);
463 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
472 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const AttributePtr& theAttr)
474 FeaturePtr anOwner = ModelAPI_Feature::feature(theAttr->owner());
475 myDumpBuffer << name(anOwner) << "." << attributeGetter(anOwner, theAttr->id()) << "()";
479 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
480 const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr)
482 if (theRefAttr->isObject())
483 *this << theRefAttr->object();
485 *this << theRefAttr->attr();
489 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
490 const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList)
493 std::list<std::pair<ObjectPtr, AttributePtr> > aList = theRefAttrList->list();
494 bool isAdded = false;
495 std::list<std::pair<ObjectPtr, AttributePtr> >::const_iterator anIt = aList.begin();
496 for (; anIt != aList.end(); ++anIt) {
498 myDumpBuffer << ", ";
502 *this << anIt->first;
503 else if (anIt->second)
504 * this << anIt->second;
510 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
511 const std::shared_ptr<ModelAPI_AttributeReference>& theReference)
513 *this << theReference->value();
517 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
518 const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList)
520 static const int aThreshold = 2;
521 // if number of elements in the list if greater than a threshold,
522 // dump it in a separate line with specific name
523 std::string aDumped = myDumpBuffer.str();
524 if (aDumped.empty() || theRefList->size() <= aThreshold) {
526 std::list<ObjectPtr> aList = theRefList->list();
527 bool isAdded = false;
528 std::list<ObjectPtr>::const_iterator anIt = aList.begin();
529 for (; anIt != aList.end(); ++anIt) {
531 myDumpBuffer << ", ";
539 // clear buffer and store list "as is"
540 myDumpBuffer.str("");
542 // save buffer and clear it again
543 std::string aDumpedList = myDumpBuffer.str();
544 myDumpBuffer.str("");
545 // obtain name of list
546 FeaturePtr anOwner = ModelAPI_Feature::feature(theRefList->owner());
547 std::string aListName = name(anOwner) + "_objects";
548 // store all previous data
549 myDumpBuffer << aListName << " = " << aDumpedList << std::endl
550 << aDumped << aListName;
555 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
556 const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect)
558 myDumpBuffer << "model.selection(";
560 if(!theAttrSelect->isInitialized()) {
565 GeomShapePtr aShape = theAttrSelect->value();
567 aShape = theAttrSelect->context()->shape();
575 myDumpBuffer << "\"" << aShape->shapeTypeStr() << "\", \"" << theAttrSelect->namingName() << "\")";
579 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
580 const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList)
585 std::string aShapeTypeStr;
587 bool isAdded = false;
589 for(int anIndex = 0; anIndex < theAttrSelList->size(); ++anIndex) {
590 AttributeSelectionPtr anAttribute = theAttrSelList->value(anIndex);
591 aShape = anAttribute->value();
593 aShape = anAttribute->context()->shape();
601 myDumpBuffer << ", ";
605 myDumpBuffer << "model.selection(\"" << aShape->shapeTypeStr() << "\", \"" << anAttribute->namingName() << "\")";
614 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
615 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&))
617 theDumper.myDumpBuffer << theEndl;
618 theDumper.dumpEntitySetName();
620 // store all not-dumped entities first
621 std::set<EntityPtr> aNotDumped = theDumper.myNotDumpedEntities;
622 std::string aBufCopy = theDumper.myDumpBuffer.str();
623 theDumper.clear(true);
624 std::set<EntityPtr>::const_iterator anIt = aNotDumped.begin();
625 for (; anIt != aNotDumped.end(); ++anIt) {
626 // if the feature is composite, dump it with all subs
627 CompositeFeaturePtr aCompFeat =
628 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anIt);
630 theDumper.process(aCompFeat, true);
632 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
633 theDumper.dumpFeature(aFeature, true);
637 // avoid multiple empty lines
638 size_t anInd = std::string::npos;
639 while ((anInd = aBufCopy.find("\n\n\n")) != std::string::npos)
640 aBufCopy.erase(anInd, 1);
641 // then store currently dumped string
642 theDumper.myFullDump << aBufCopy;