1 // Copyright (C) 2014-2019 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 email : webmaster.salome@opencascade.com
20 #include <ExchangePlugin_ExportFeature.h>
30 #include <Config_Common.h>
31 #include <Config_PropManager.h>
33 #include <GeomAlgoAPI_BREPExport.h>
34 #include <GeomAlgoAPI_CompoundBuilder.h>
35 #include <GeomAlgoAPI_IGESExport.h>
36 #include <GeomAlgoAPI_STEPExport.h>
37 #include <GeomAlgoAPI_Tools.h>
38 #include <GeomAlgoAPI_XAOExport.h>
40 #include <GeomAPI_Shape.h>
41 #include <GeomAPI_ShapeExplorer.h>
43 #include <ModelAPI_AttributeSelectionList.h>
44 #include <ModelAPI_AttributeString.h>
45 #include <ModelAPI_AttributeStringArray.h>
46 #include <ModelAPI_AttributeIntArray.h>
47 #include <ModelAPI_AttributeTables.h>
48 #include <ModelAPI_Data.h>
49 #include <ModelAPI_Document.h>
50 #include <ModelAPI_Object.h>
51 #include <ModelAPI_ResultBody.h>
52 #include <ModelAPI_ResultPart.h>
53 #include <ModelAPI_ResultGroup.h>
54 #include <ModelAPI_ResultField.h>
55 #include <ModelAPI_Session.h>
56 #include <ModelAPI_Validator.h>
57 #include <ModelAPI_Tools.h>
59 #include <Events_InfoMessage.h>
61 #include <XAO_Group.hxx>
62 #include <XAO_Field.hxx>
63 #include <XAO_Xao.hxx>
64 #include <XAO_Geometry.hxx>
66 #include <ExchangePlugin_Tools.h>
68 ExchangePlugin_ExportFeature::ExchangePlugin_ExportFeature()
72 ExchangePlugin_ExportFeature::~ExchangePlugin_ExportFeature()
74 // TODO Auto-generated destructor stub
78 * Request for initialization of data model of the feature: adding all attributes
80 void ExchangePlugin_ExportFeature::initAttributes()
82 data()->addAttribute(ExchangePlugin_ExportFeature::EXPORT_TYPE_ID(),
83 ModelAPI_AttributeString::typeId());
84 data()->addAttribute(ExchangePlugin_ExportFeature::FILE_PATH_ID(),
85 ModelAPI_AttributeString::typeId());
86 data()->addAttribute(ExchangePlugin_ExportFeature::XAO_FILE_PATH_ID(),
87 ModelAPI_AttributeString::typeId());
88 data()->addAttribute(ExchangePlugin_ExportFeature::FILE_FORMAT_ID(),
89 ModelAPI_AttributeString::typeId());
90 data()->addAttribute(ExchangePlugin_ExportFeature::SELECTION_LIST_ID(),
91 ModelAPI_AttributeSelectionList::typeId());
92 data()->addAttribute(ExchangePlugin_ExportFeature::XAO_AUTHOR_ID(),
93 ModelAPI_AttributeString::typeId());
94 data()->addAttribute(ExchangePlugin_ExportFeature::XAO_GEOMETRY_NAME_ID(),
95 ModelAPI_AttributeString::typeId());
97 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(),
98 ExchangePlugin_ExportFeature::XAO_FILE_PATH_ID());
99 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(),
100 ExchangePlugin_ExportFeature::XAO_AUTHOR_ID());
101 ModelAPI_Session::get()->validators()->registerNotObligatory(getKind(),
102 ExchangePlugin_ExportFeature::XAO_GEOMETRY_NAME_ID());
105 void ExchangePlugin_ExportFeature::attributeChanged(const std::string& theID)
107 if (theID == XAO_FILE_PATH_ID()) {
108 string(ExchangePlugin_ExportFeature::FILE_PATH_ID())->setValue(
109 string(ExchangePlugin_ExportFeature::XAO_FILE_PATH_ID())->value());
114 * Computes or recomputes the results
116 void ExchangePlugin_ExportFeature::execute()
118 AttributeStringPtr aFormatAttr =
119 this->string(ExchangePlugin_ExportFeature::FILE_FORMAT_ID());
120 std::string aFormat = aFormatAttr->value();
122 AttributeStringPtr aFilePathAttr =
123 this->string(ExchangePlugin_ExportFeature::FILE_PATH_ID());
124 std::string aFilePath = aFilePathAttr->value();
125 if (aFilePath.empty())
128 exportFile(aFilePath, aFormat);
131 void ExchangePlugin_ExportFeature::exportFile(const std::string& theFileName,
132 const std::string& theFormat)
134 std::string aFormatName = theFormat;
136 if (aFormatName.empty()) { // get default format for the extension
138 std::string anExtension = GeomAlgoAPI_Tools::File_Tools::extension(theFileName);
139 if (anExtension == "BREP" || anExtension == "BRP") {
140 aFormatName = "BREP";
141 } else if (anExtension == "STEP" || anExtension == "STP") {
142 aFormatName = "STEP";
143 } else if (anExtension == "IGES" || anExtension == "IGS") {
144 aFormatName = "IGES-5.1";
146 aFormatName = anExtension;
150 if (aFormatName == "XAO") {
151 exportXAO(theFileName);
155 // make shape for export from selected shapes
156 AttributeSelectionListPtr aSelectionListAttr =
157 this->selectionList(ExchangePlugin_ExportFeature::SELECTION_LIST_ID());
158 std::list<GeomShapePtr> aShapes;
159 for (int i = 0, aSize = aSelectionListAttr->size(); i < aSize; ++i) {
160 AttributeSelectionPtr anAttrSelection = aSelectionListAttr->value(i);
161 std::shared_ptr<GeomAPI_Shape> aCurShape = anAttrSelection->value();
162 if (aCurShape.get() == NULL)
163 aCurShape = anAttrSelection->context()->shape();
164 if (aCurShape.get() != NULL)
165 aShapes.push_back(aCurShape);
168 // Store compound if we have more than one shape.
169 std::shared_ptr<GeomAPI_Shape> aShape =
170 aShapes.size() == 1 ? aShapes.front() : GeomAlgoAPI_CompoundBuilder::compound(aShapes);
172 // Perform the export
174 bool aResult = false;
175 if (aFormatName == "BREP") {
176 aResult = BREPExport(theFileName, aFormatName, aShape, anError);
177 } else if (aFormatName == "STEP") {
178 aResult = STEPExport(theFileName, aFormatName, aShape, anError);
179 } else if (aFormatName.substr(0, 4) == "IGES") {
180 aResult = IGESExport(theFileName, aFormatName, aShape, anError);
182 anError = "Unsupported format: " + aFormatName;
185 if (!anError.empty()) {
186 setError("An error occurred while exporting " + theFileName + ": " + anError);
191 /// Returns XAO string by the value from the table
192 static std::string valToString(const ModelAPI_AttributeTables::Value& theVal,
193 const ModelAPI_AttributeTables::ValueType& theType) {
194 std::ostringstream aStr; // the resulting string value
196 case ModelAPI_AttributeTables::BOOLEAN:
197 aStr<<(theVal.myBool ? "true" : "false");
199 case ModelAPI_AttributeTables::INTEGER:
202 case ModelAPI_AttributeTables::DOUBLE:
203 aStr<<theVal.myDouble;
205 case ModelAPI_AttributeTables::STRING:
212 /// Returns true if something in selection is presented in the results list
213 static bool isInResults(AttributeSelectionListPtr theSelection,
214 const std::list<ResultPtr>& theResults,
215 std::set<ResultPtr>& theCashedResults)
217 // collect all results into a cashed set
218 if (theCashedResults.empty()) {
219 std::list<ResultPtr> aResults;
220 std::list<ResultPtr>::const_iterator aRes = theResults.cbegin();
221 for(; aRes != theResults.cend(); aRes++) {
222 if (theCashedResults.count(*aRes))
225 theCashedResults.insert(*aRes);
226 if ((*aRes)->groupName() == ModelAPI_ResultBody::group()) {
227 ResultBodyPtr aResBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(*aRes);
228 std::list<ResultPtr> aResults;
229 ModelAPI_Tools::allSubs(aResBody, aResults, false);
230 for(std::list<ResultPtr>::iterator aR = aResults.begin(); aR != aResults.end(); aR++) {
231 theCashedResults.insert(std::dynamic_pointer_cast<ModelAPI_ResultBody>(*aR));
233 } else if ((*aRes)->groupName() == ModelAPI_ResultPart::group()) { // all results of the part
234 ResultPartPtr aResPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes);
235 DocumentPtr aPartDoc = aResPart->partDoc();
236 if (!aPartDoc.get() || !aPartDoc->isOpened()) { // document is not accessible
239 int aBodyCount = aPartDoc->size(ModelAPI_ResultBody::group());
240 for (int aBodyIndex = 0; aBodyIndex < aBodyCount; ++aBodyIndex) {
241 ResultBodyPtr aResBody =
242 std::dynamic_pointer_cast<ModelAPI_ResultBody>(
243 aPartDoc->object(ModelAPI_ResultBody::group(), aBodyIndex));
244 if (aResBody.get()) {
245 theCashedResults.insert(aResBody);
246 std::list<ResultPtr> aResults;
247 ModelAPI_Tools::allSubs(aResBody, aResults, false);
248 for(std::list<ResultPtr>::iterator aR = aResults.begin(); aR != aResults.end(); aR++) {
249 theCashedResults.insert(std::dynamic_pointer_cast<ModelAPI_ResultBody>(*aR));
256 // if context is in results, return true
257 for(int a = 0; a < theSelection->size(); a++) {
258 AttributeSelectionPtr anAttr = theSelection->value(a);
259 ResultBodyPtr aSelected= std::dynamic_pointer_cast<ModelAPI_ResultBody>(anAttr->context());
260 if (aSelected.get() && theCashedResults.count(aSelected))
266 /// Returns all sub-shapes of the given shape in theResult
267 static void allSubShapes(const GeomShapePtr theShape, GeomAPI_Shape::ShapeType theType,
268 std::list<GeomShapePtr>& theResult)
270 if (theShape->shapeType() == theType) {
271 theResult.push_back(theShape);
273 GeomAPI_DataMapOfShapeShape aUnique; // to keep only unique shapes
274 for(GeomAPI_ShapeExplorer anExp(theShape, theType); anExp.more(); anExp.next()) {
275 if (aUnique.bind(anExp.current(), anExp.current()))
276 theResult.push_back(anExp.current());
281 void ExchangePlugin_ExportFeature::exportXAO(const std::string& theFileName)
290 std::string anAuthor = string(ExchangePlugin_ExportFeature::XAO_AUTHOR_ID())->value();
291 aXao.setAuthor(anAuthor);
293 // make shape for export from all results
294 std::list<GeomShapePtr> aShapes;
295 std::list<ResultPtr> aResults;
296 std::list<DocumentPtr> aDocuments; /// documents of Parts selected and used in export
298 AttributeSelectionListPtr aSelection = selectionList(SELECTION_LIST_ID());
299 bool aIsSelection = aSelection->isInitialized() && aSelection->size() > 0;
300 if (aIsSelection) { // a mode for export to geom result by result
301 for(int a = 0; a < aSelection->size(); a++) {
302 AttributeSelectionPtr anAttr = aSelection->value(a);
303 ResultPtr aBodyContext =
304 std::dynamic_pointer_cast<ModelAPI_Result>(anAttr->context());
305 if (aBodyContext.get() && !aBodyContext->isDisabled() && aBodyContext->shape().get()) {
306 aResults.push_back(aBodyContext);
307 GeomShapePtr aShape = anAttr->value();
309 aShape = aBodyContext->shape();
310 aShapes.push_back(aShape);
311 if (aBodyContext->groupName() == ModelAPI_ResultPart::group()) {
312 ResultPartPtr aResPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(aBodyContext);
313 DocumentPtr aPartDoc = aResPart->partDoc();
314 if (!aPartDoc.get() || !aPartDoc->isOpened()) { // document is not accessible
315 std::string msg = "Can not export XAO for not loaded part";
316 Events_InfoMessage("ExportFeature", msg, this).send();
319 aDocuments.push_back(aPartDoc);
325 int aBodyCount = document()->size(ModelAPI_ResultBody::group());
326 for (int aBodyIndex = 0; aBodyIndex < aBodyCount; ++aBodyIndex) {
327 ResultBodyPtr aResultBody =
328 std::dynamic_pointer_cast<ModelAPI_ResultBody>(
329 document()->object(ModelAPI_ResultBody::group(), aBodyIndex));
330 if (!aResultBody.get())
332 aShapes.push_back(aResultBody->shape());
333 aResults.push_back(aResultBody);
336 if (aShapes.empty()) {
337 setError("No shapes to export");
342 GeomShapePtr aShape = (aShapes.size() == 1)
344 : GeomAlgoAPI_CompoundBuilder::compound(aShapes);
346 SetShapeToXAO(aShape, &aXao, anError);
348 if (!anError.empty()) {
349 setError("An error occurred while exporting " + theFileName + ": " + anError);
354 std::string aGeometryName = string(ExchangePlugin_ExportFeature::XAO_GEOMETRY_NAME_ID())->value();
355 if (aGeometryName.empty() && aResults.size() == 1) {
356 // get the name from the first result
357 ResultPtr aResultBody = *aResults.begin();
358 aGeometryName = aResultBody->data()->name();
361 aXao.getGeometry()->setName(aGeometryName);
363 std::set<ResultPtr> allResultsCashed; // cash to speed up searching in all results selected
365 // iterate all documents used
366 if (aDocuments.empty())
367 aDocuments.push_back(document());
368 std::list<DocumentPtr>::iterator aDoc = aDocuments.begin();
369 for(; aDoc != aDocuments.end(); aDoc++) {
371 int aGroupCount = (*aDoc)->size(ModelAPI_ResultGroup::group());
372 for (int aGroupIndex = 0; aGroupIndex < aGroupCount; ++aGroupIndex) {
373 ResultGroupPtr aResultGroup = std::dynamic_pointer_cast<ModelAPI_ResultGroup>(
374 (*aDoc)->object(ModelAPI_ResultGroup::group(), aGroupIndex));
376 FeaturePtr aGroupFeature = (*aDoc)->feature(aResultGroup);
378 AttributeSelectionListPtr aSelectionList =
379 aGroupFeature->selectionList("group_list");
380 if (!isInResults(aSelectionList, aResults, allResultsCashed))// skip group not used in result
383 // conversion of dimension
384 std::string aSelectionType = aSelectionList->selectionType();
385 GeomAPI_Shape::ShapeType aSelType = GeomAPI_Shape::shapeTypeByStr(aSelectionType);
386 std::string aDimensionString =
387 ExchangePlugin_Tools::selectionType2xaoDimension(aSelectionType);
388 XAO::Dimension aGroupDimension = XAO::XaoUtils::stringToDimension(aDimensionString);
390 XAO::Group* aXaoGroup = aXao.addGroup(aGroupDimension,
391 aResultGroup->data()->name());
394 for (int aSelectionIndex = 0; aSelectionIndex < aSelectionList->size(); ++aSelectionIndex){
395 AttributeSelectionPtr aSelection = aSelectionList->value(aSelectionIndex);
396 GeomShapePtr aSelShape = aSelection->value();
397 if (!aSelShape.get() && aSelection->context().get()) {
398 aSelShape = aSelection->context()->shape();
401 std::list<GeomShapePtr> allSubs;
402 allSubShapes(aSelShape, aSelType, allSubs);
404 std::list<GeomShapePtr>::iterator anIter = allSubs.begin();
405 for(; anIter != allSubs.end(); anIter++) {
406 int aReferenceID = GeomAlgoAPI_CompoundBuilder::id(aShape, *anIter);
407 if (aReferenceID == 0) // selected value does not found in the exported shape
409 std::string aReferenceString = XAO::XaoUtils::intToString(aReferenceID);
411 aXao.getGeometry()->getElementIndexByReference(aGroupDimension, aReferenceString);
412 aXaoGroup->add(anElementID);
415 } catch (XAO::XAO_Exception& e) {
417 std::string msg = "An error occurred while exporting group " +
418 aResultGroup->data()->name();
422 msg += "=> skipping this group from XAO export.";
423 Events_InfoMessage("ExportFeature", msg, this).send();
424 aXao.removeGroup(aXaoGroup);
430 int aFieldCount = (*aDoc)->size(ModelAPI_ResultField::group());
431 for (int aFieldIndex = 0; aFieldIndex < aFieldCount; ++aFieldIndex) {
432 ResultFieldPtr aResultField = std::dynamic_pointer_cast<ModelAPI_ResultField>(
433 (*aDoc)->object(ModelAPI_ResultField::group(), aFieldIndex));
435 FeaturePtr aFieldFeature = (*aDoc)->feature(aResultField);
437 AttributeSelectionListPtr aSelectionList =
438 aFieldFeature->selectionList("selected");
439 std::string aSelectionType = aSelectionList->selectionType();
440 bool isWholePart = aSelectionType == "part";
441 // skip field not used in results
442 if (!isWholePart && !isInResults(aSelectionList, aResults, allResultsCashed))
445 // conversion of dimension
446 std::string aDimensionString =
447 ExchangePlugin_Tools::selectionType2xaoDimension(aSelectionType);
448 XAO::Dimension aFieldDimension = XAO::XaoUtils::stringToDimension(aDimensionString);
449 // get tables and their type
450 std::shared_ptr<ModelAPI_AttributeTables> aTables = aFieldFeature->tables("values");
451 std::string aTypeString = ExchangePlugin_Tools::valuesType2xaoType(aTables->type());
452 XAO::Type aFieldType = XAO::XaoUtils::stringToFieldType(aTypeString);
454 XAO::Field* aXaoField = aXao.addField(aFieldType, aFieldDimension, aTables->columns(),
455 aResultField->data()->name());
459 // set components names
460 AttributeStringArrayPtr aComponents = aFieldFeature->stringArray("components_names");
461 for(int aComp = 0; aComp < aComponents->size(); aComp++) {
462 std::string aName = aComponents->value(aComp);
463 aXaoField->setComponentName(aComp, aName);
466 AttributeIntArrayPtr aStamps = aFieldFeature->intArray("stamps");
467 for (int aStepIndex = 0; aStepIndex < aTables->tables(); aStepIndex++) {
468 XAO::Step* aStep = aXaoField->addNewStep(aStepIndex + 1);
469 aStep->setStep(aStepIndex + 1);
470 int aStampIndex = aStamps->value(aStepIndex);
471 aStep->setStamp(aStampIndex);
472 int aNumElements = isWholePart ? aXaoField->countElements() : aTables->rows();
473 int aNumComps = aTables->columns();
474 std::set<int> aFilledIDs; // to fill the rest by defaults
475 // omit default values first row
476 for(int aRow = isWholePart ? 0 : 1; aRow < aNumElements; aRow++) {
477 for(int aCol = 0; aCol < aNumComps; aCol++) {
480 // element index actually is the ID of the selection
481 AttributeSelectionPtr aSelection = aSelectionList->value(aRow - 1);
482 int aReferenceID = GeomAlgoAPI_CompoundBuilder::id(aShape, aSelection->value());
483 if (aReferenceID == 0) // selected value does not found in the exported shape
486 std::string aReferenceString = XAO::XaoUtils::intToString(aReferenceID);
487 anElementID = aXao.getGeometry()->
488 getElementIndexByReference(aFieldDimension, aReferenceString);
491 ModelAPI_AttributeTables::Value aVal = aTables->value(
492 isWholePart ? 0 : aRow, aCol, aStepIndex);
493 std::string aStrVal = valToString(aVal, aTables->type());
494 aStep->setStringValue(isWholePart ? aRow : anElementID, aCol, aStrVal);
495 aFilledIDs.insert(anElementID);
498 if (!isWholePart) { // fill the rest values by default ones
499 XAO::GeometricElementList::iterator allElem =
500 aXao.getGeometry()->begin(aFieldDimension);
501 for(; allElem != aXao.getGeometry()->end(aFieldDimension); allElem++) {
502 if (aFilledIDs.find(allElem->first) != aFilledIDs.end())
504 for(int aCol = 0; aCol < aNumComps; aCol++) {
506 ModelAPI_AttributeTables::Value aVal = aTables->value(0, aCol, aStepIndex);
507 std::string aStrVal = valToString(aVal, aTables->type());
508 aStep->setStringValue(allElem->first, aCol, aStrVal);
513 } catch (XAO::XAO_Exception& e) {
515 std::string msg = "An error occurred while exporting field " +
516 aResultField->data()->name();
520 msg += "=> skipping this field from XAO export.";
521 Events_InfoMessage("ExportFeature", msg, this).send();
522 aXao.removeField(aXaoField);
529 XAOExport(theFileName, &aXao, anError);
531 if (!anError.empty()) {
532 setError("An error occurred while exporting " + theFileName + ": " + anError);
537 } catch (XAO::XAO_Exception& e) {
538 std::string anError = e.what();
539 setError("An error occurred while exporting " + theFileName + ": " + anError);
545 bool ExchangePlugin_ExportFeature::isMacro() const
547 if (!data().get() || !data()->isValid())
549 ExchangePlugin_ExportFeature* aThis = ((ExchangePlugin_ExportFeature*)(this));
550 AttributeStringPtr aFormatAttr = aThis->string(FILE_FORMAT_ID());
551 std::string aFormat(aFormatAttr.get() ? aFormatAttr->value() : "");
553 if (aFormat.empty()) { // get default format for the extension
554 AttributeStringPtr aFilePathAttr = aThis->string(FILE_PATH_ID());
555 std::string aFilePath = aFilePathAttr->value();
556 if (!aFilePath.empty()) {
557 std::string anExtension = GeomAlgoAPI_Tools::File_Tools::extension(aFilePath);
558 aFormat = anExtension;
562 if (aFormat == "XAO") { // on export to GEOm the selection attribute is filled - this is
563 // an exceptional case where export to XAO feature must be kept
564 AttributeSelectionListPtr aList = aThis->selectionList(SELECTION_LIST_ID());
565 return !aList->isInitialized() || aList->size() == 0;