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 << ".setName(\"" << aName << "\")" << std::endl;
290 myNames[myLastEntityWithName].second = false; // don't dump "setName" for the entity twice
291 myLastEntityWithName = EntityPtr();
294 bool ModelHighAPI_Dumper::isDumped(const EntityPtr& theEntity) const
296 EntityNameMap::const_iterator aFound = myNames.find(theEntity);
297 return aFound != myNames.end();
300 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char theChar)
302 myDumpBuffer << theChar;
306 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char* theString)
308 myDumpBuffer << theString;
312 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::string& theString)
314 myDumpBuffer << theString;
318 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const bool theValue)
320 myDumpBuffer << (theValue ? "True" : "False");
324 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const int theValue)
326 myDumpBuffer << theValue;
330 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const double theValue)
332 myDumpBuffer << theValue;
336 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint)
338 importModule("GeomAPI", "GeomAPI_Pnt");
339 myDumpBuffer << "GeomAPI_Pnt(" << thePoint->x() << ", "
340 << thePoint->y() << ", " << thePoint->z() << ")";
344 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir)
346 importModule("GeomAPI", "GeomAPI_Dir");
347 myDumpBuffer << "GeomAPI_Dir(" << theDir->x() << ", "
348 << theDir->y() << ", " << theDir->z() << ")";
352 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
353 const std::shared_ptr<GeomDataAPI_Dir>& theDir)
355 myDumpBuffer << theDir->x() << ", " << theDir->y() << ", " << theDir->z();
359 static void dumpArray(std::ostringstream& theOutput, int theSize,
360 double* theValues, std::string* theTexts)
362 for (int i = 0; i < theSize; ++i) {
365 if (theTexts[i].empty())
366 theOutput << theValues[i];
368 theOutput << "\"" << theTexts[i] << "\"";
372 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
373 const std::shared_ptr<GeomDataAPI_Point>& thePoint)
375 static const int aSize = 3;
376 double aValues[aSize] = {thePoint->x(), thePoint->y(), thePoint->z()};
377 std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY(), thePoint->textZ()};
378 dumpArray(myDumpBuffer, aSize, aValues, aTexts);
382 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
383 const std::shared_ptr<GeomDataAPI_Point2D>& thePoint)
385 static const int aSize = 2;
386 double aValues[aSize] = {thePoint->x(), thePoint->y()};
387 std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY()};
388 dumpArray(myDumpBuffer, aSize, aValues, aTexts);
392 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
393 const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool)
395 myDumpBuffer << (theAttrBool->value() ? "True" : "False");
399 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
400 const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt)
402 std::string aText = theAttrInt->text();
404 myDumpBuffer << theAttrInt->value();
406 myDumpBuffer << "\"" << aText << "\"";
410 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
411 const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal)
413 std::string aText = theAttrReal->text();
415 myDumpBuffer << theAttrReal->value();
417 myDumpBuffer << "\"" << aText << "\"";
421 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
422 const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr)
424 myDumpBuffer << "\"" << theAttrStr->value() << "\"";
428 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FeaturePtr& theEntity)
430 myDumpBuffer << name(theEntity);
431 if (myNames[theEntity].second)
432 myLastEntityWithName = theEntity;
433 myNotDumpedEntities.erase(theEntity);
437 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ResultPtr& theResult)
439 FeaturePtr aFeature = ModelAPI_Feature::feature(theResult);
441 std::list<ResultPtr> aResults = aFeature->results();
442 for(std::list<ResultPtr>::const_iterator anIt = aResults.cbegin(); anIt != aResults.cend(); ++anIt, ++anIndex) {
443 if(theResult->isSame(*anIt)) {
447 myDumpBuffer << name(aFeature) << ".result()[" << anIndex << "]";
451 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ObjectPtr& theObject)
453 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
455 myDumpBuffer << name(aFeature);
459 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
468 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const AttributePtr& theAttr)
470 FeaturePtr anOwner = ModelAPI_Feature::feature(theAttr->owner());
471 myDumpBuffer << name(anOwner) << "." << attributeGetter(anOwner, theAttr->id()) << "()";
475 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
476 const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr)
478 if (theRefAttr->isObject())
479 *this << theRefAttr->object();
481 *this << theRefAttr->attr();
485 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
486 const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList)
489 std::list<std::pair<ObjectPtr, AttributePtr> > aList = theRefAttrList->list();
490 bool isAdded = false;
491 std::list<std::pair<ObjectPtr, AttributePtr> >::const_iterator anIt = aList.begin();
492 for (; anIt != aList.end(); ++anIt) {
494 myDumpBuffer << ", ";
498 *this << anIt->first;
499 else if (anIt->second)
500 * this << anIt->second;
506 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
507 const std::shared_ptr<ModelAPI_AttributeReference>& theReference)
509 *this << theReference->value();
513 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
514 const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList)
516 static const int aThreshold = 2;
517 // if number of elements in the list if greater than a threshold,
518 // dump it in a separate line with specific name
519 std::string aDumped = myDumpBuffer.str();
520 if (aDumped.empty() || theRefList->size() <= aThreshold) {
522 std::list<ObjectPtr> aList = theRefList->list();
523 bool isAdded = false;
524 std::list<ObjectPtr>::const_iterator anIt = aList.begin();
525 for (; anIt != aList.end(); ++anIt) {
527 myDumpBuffer << ", ";
535 // clear buffer and store list "as is"
536 myDumpBuffer.str("");
538 // save buffer and clear it again
539 std::string aDumpedList = myDumpBuffer.str();
540 myDumpBuffer.str("");
541 // obtain name of list
542 FeaturePtr anOwner = ModelAPI_Feature::feature(theRefList->owner());
543 std::string aListName = name(anOwner) + "_objects";
544 // store all previous data
545 myDumpBuffer << aListName << " = " << aDumpedList << std::endl
546 << aDumped << aListName;
551 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
552 const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect)
554 myDumpBuffer << "model.selection(";
556 if(!theAttrSelect->isInitialized()) {
561 GeomShapePtr aShape = theAttrSelect->value();
563 aShape = theAttrSelect->context()->shape();
571 myDumpBuffer << "\"" << aShape->shapeTypeStr() << "\", \"" << theAttrSelect->namingName() << "\")";
575 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
576 const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList)
581 std::string aShapeTypeStr;
583 bool isAdded = false;
585 for(int anIndex = 0; anIndex < theAttrSelList->size(); ++anIndex) {
586 AttributeSelectionPtr anAttribute = theAttrSelList->value(anIndex);
587 aShape = anAttribute->value();
589 aShape = anAttribute->context()->shape();
597 myDumpBuffer << ", ";
601 myDumpBuffer << "model.selection(\"" << aShape->shapeTypeStr() << "\", \"" << anAttribute->namingName() << "\")";
610 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
611 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&))
613 theDumper.myDumpBuffer << theEndl;
614 theDumper.dumpEntitySetName();
616 // store all not-dumped entities first
617 std::set<EntityPtr> aNotDumped = theDumper.myNotDumpedEntities;
618 std::string aBufCopy = theDumper.myDumpBuffer.str();
619 theDumper.clear(true);
620 std::set<EntityPtr>::const_iterator anIt = aNotDumped.begin();
621 for (; anIt != aNotDumped.end(); ++anIt) {
622 // if the feature is composite, dump it with all subs
623 CompositeFeaturePtr aCompFeat =
624 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anIt);
626 theDumper.process(aCompFeat, true);
628 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
629 theDumper.dumpFeature(aFeature, true);
633 // avoid multiple empty lines
634 size_t anInd = std::string::npos;
635 while ((anInd = aBufCopy.find("\n\n\n")) != std::string::npos)
636 aBufCopy.erase(anInd, 1);
637 // then store currently dumped string
638 theDumper.myFullDump << aBufCopy;