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 #ifndef ModelHighAPI_Dumper_H_
22 #define ModelHighAPI_Dumper_H_
24 #include "ModelHighAPI.h"
37 class GeomDataAPI_Dir;
38 class GeomDataAPI_Point;
39 class GeomDataAPI_Point2D;
41 class ModelAPI_Attribute;
42 class ModelAPI_AttributeBoolean;
43 class ModelAPI_AttributeDouble;
44 class ModelAPI_AttributeInteger;
45 class ModelAPI_AttributeRefAttr;
46 class ModelAPI_AttributeRefAttrList;
47 class ModelAPI_AttributeReference;
48 class ModelAPI_AttributeRefList;
49 class ModelAPI_AttributeSelection;
50 class ModelAPI_AttributeSelectionList;
51 class ModelAPI_AttributeString;
52 class ModelAPI_AttributeStringArray;
53 class ModelAPI_CompositeFeature;
54 class ModelAPI_Document;
55 class ModelAPI_Entity;
56 class ModelAPI_Feature;
57 class ModelAPI_Folder;
58 class ModelAPI_Object;
59 class ModelAPI_Result;
61 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
62 typedef std::shared_ptr<ModelAPI_Entity> EntityPtr;
63 typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;
64 typedef std::shared_ptr<ModelAPI_Folder> FolderPtr;
65 typedef std::shared_ptr<ModelAPI_Result> ResultPtr;
67 /**\class ModelHighAPI_Dumper
69 * \brief Dump engine for the model
71 class ModelHighAPI_Dumper
74 /// Default constructor
76 ModelHighAPI_Dumper();
78 /// Sets instance of a dumper
80 static void setInstance(ModelHighAPI_Dumper* theDumper);
82 /// Returns instance of a dumper
84 static ModelHighAPI_Dumper* getInstance();
87 virtual ~ModelHighAPI_Dumper() {}
89 /// Set/unset flag to dump selection attributes by geometrical properties:
90 /// inner point in the selected shape
91 void setSelectionByGeometry(bool theDumpByGeom = true)
92 { myGeometricalSelection = theDumpByGeom; }
94 /// Dump given document into the file
95 /// \return \c true, if succeed
97 bool process(const std::shared_ptr<ModelAPI_Document>& theDoc, const std::string& theFileName);
99 /// Add module to list of imported modules
100 /// \param theModuleName name of the module to be imported
101 /// \param theObject name of the entity to be imported
102 /// from the module (if empty, while module will be imported)
104 void importModule(const std::string& theModuleName,
105 const std::string& theObject = std::string());
107 /// Returns name of specified entity
108 /// \param theEntity [in] named entity
109 /// \param theSaveNotDumped [in]
110 /// if \c true, the entity should be stored as not dumped (will be dumped automatically)
111 /// \param theUseEntityName [in]
112 /// if \c true, the entity name should be used "as is" without changing default name
113 /// \return name of the entity
115 const std::string& name(const EntityPtr& theEntity, bool theSaveNotDumped = true,
116 bool theUseEntityName = false);
118 /// Returns name of parent composite feature for specified entity
120 const std::string& parentName(const FeaturePtr& theFeature);
122 /// Dump parameter feature only
123 virtual void dumpParameter(const FeaturePtr& theFeature) = 0;
124 /// Dump given feature
125 virtual void dumpFeature(const FeaturePtr& theFeature, const bool theForce = false) = 0;
127 virtual void dumpFolder(const FolderPtr& theFolder) = 0;
129 /// Set feature postponed until all its dependencies are not dumped.
130 /// The name of the feature is stored anyway.
132 void postpone(const EntityPtr& theEntity);
134 /// Set a feature that should not be dumped anyway
136 void doNotDumpFeature(const FeaturePtr& theFeature)
137 { myFeaturesToSkip.insert(theFeature); }
139 /// Dump sub-feature name and color, without dumping feature creation.
140 /// Used for features which creates sub-features in their execute method.
141 /// \param theSubFeatureGet [in] method for getting sub-feature (e.g. "Feature_1.subFeature(0)")
142 /// \param theSubFeature [in] sub-feature
144 void dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
145 const FeaturePtr& theSubFeature);
147 /// Return name of getter for corresponding attribute
148 virtual std::string attributeGetter(const FeaturePtr& theFeature,
149 const std::string& theAttrName) const = 0;
151 /// Return name of wrapper feature
152 virtual std::string featureWrapper(const FeaturePtr& theFeature) const = 0;
154 /// Save all dumps into specified file
156 bool exportTo(const std::string& theFileName);
160 ModelHighAPI_Dumper& operator<<(const char theChar);
163 ModelHighAPI_Dumper& operator<<(const char* theString);
166 ModelHighAPI_Dumper& operator<<(const std::string& theString);
169 ModelHighAPI_Dumper& operator<<(const bool theValue);
172 ModelHighAPI_Dumper& operator<<(const int theValue);
175 ModelHighAPI_Dumper& operator<<(const double theValue);
179 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
180 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&));
182 /// Dump GeomAPI_Pnt in the following form:
183 /// "GeomAPI_Pnt(X, Y, Z)"
185 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint);
187 /// "GeomAPI_Dir(X, Y, Z)"
189 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir);
191 /// Dump GeomDataAPI_Dir in the following form:
194 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Dir>& theDir);
195 /// Dump GeomDataAPI_Point in the following form:
198 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point>& thePoint);
199 /// Dump GeomDataAPI_Point2D in the following form:
202 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point2D>& thePoint);
204 /// Dump AttributeBoolean
206 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool);
207 /// Dump AttributeInteger
209 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt);
210 /// Dump AttributeDouble
212 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal);
213 /// Dump AttributeString
215 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr);
216 /// Dump name of entity and remember to dump "setName" if the entity has user-defined name
218 ModelHighAPI_Dumper& operator<<(const FeaturePtr& theEntity);
222 ModelHighAPI_Dumper& operator<<(const FolderPtr& theFolder);
226 ModelHighAPI_Dumper& operator<<(const ResultPtr& theResult);
229 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
230 operator<<(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
232 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
233 operator<<(const std::shared_ptr<ModelAPI_Object>& theObject);
235 /// Dump AttributeRefAttr
236 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
237 operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr);
238 /// Dump AttributeRefAttrList as follows:
239 /// "[obj1, obj2, obj3, ...]"
240 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
241 operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList);
242 /// Dump AttributeRefList as follows:
243 /// "[obj1, obj2, obj3, ...]"
244 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
245 operator<<(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList);
246 /// Dump AttributeSelection
247 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
248 operator<<(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
249 /// Dump AttributeSelectionList
250 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
251 operator<<(const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList);
252 /// Dump AttributeReference
253 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
254 operator<<(const std::shared_ptr<ModelAPI_AttributeReference>& theReference);
255 /// Dump AttributeStringArray
256 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
257 operator<<(const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray);
259 /// Clear dump buffer
261 void clear(bool bufferOnly = false);
262 /// clear list of not dumped entities
263 MODELHIGHAPI_EXPORT void clearNotDumped();
265 /// Check the entity is already dumped
267 bool isDumped(const EntityPtr& theEntity) const;
268 /// Check theRefAttr is already dumped
270 bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr) const;
271 /// Check all objects in theRefList are already dumped
273 bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList) const;
276 /// Dump "setName" command if last entity had user-defined name
277 MODELHIGHAPI_EXPORT void dumpEntitySetName();
280 ModelHighAPI_Dumper(const ModelHighAPI_Dumper&);
281 const ModelHighAPI_Dumper& operator=(const ModelHighAPI_Dumper&);
283 /// Iterate all features in document and dump them into intermediate buffer
284 bool process(const std::shared_ptr<ModelAPI_Document>& theDoc);
286 /// Dump composite feature and all it sub-features
287 bool process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
288 bool isForce = false);
290 /// Iterate all features in composite feature and dump them into intermediate buffer
291 /// \param theComposite [in] parent composite feature
292 /// \param theDumpModelDo [in] shows that command "model.do()" should be written at the end
294 bool processSubs(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
295 bool theDumpModelDo = false);
297 /// Stores names of results for the given feature
298 void saveResultNames(const FeaturePtr& theFeature);
300 /// Check the result feature has default color
301 bool isDefaultColor(const ResultPtr& theResult) const;
303 /// Check the result feature has default deflection
304 bool isDefaultDeflection(const ResultPtr& theResult) const;
306 /// Check the result feature has default transparency
307 bool isDefaultTransparency(const ResultPtr& theResult) const;
309 /// Dump postponed entities
310 void dumpPostponed(bool theDumpFolders = false);
314 std::string myCurrentName; ///< default name of current feature
315 std::string myUserName; ///< user-defined name
316 bool myIsDefault; ///< \c true if the name is default
317 bool myIsDumped; ///< shows that the names of the feature are already stored
321 EntityName(const std::string& theCurName, const std::string& theUserName, bool theDefault)
322 : myCurrentName(theCurName),
323 myUserName(theUserName),
324 myIsDefault(theDefault),
329 typedef std::map<EntityPtr, EntityName> EntityNameMap;
330 typedef std::map<std::string, std::set<std::string> > ModulesMap;
331 typedef std::map<DocumentPtr, std::map<std::string, std::pair<int, int> > > NbFeaturesMap;
333 struct LastDumpedEntity {
334 EntityPtr myEntity; ///< last dumped entity
335 bool myUserName; ///< the entity hase user-defined name
336 /// results of this entity, which has user-defined names or specific colors
337 std::list<ResultPtr> myResults;
339 LastDumpedEntity(EntityPtr theEntity, bool theUserName,
340 const std::list<ResultPtr>& theResults = std::list<ResultPtr>())
341 : myEntity(theEntity), myUserName(theUserName), myResults(theResults)
344 typedef std::stack<LastDumpedEntity> DumpStack;
346 static ModelHighAPI_Dumper* mySelf;
348 std::ostringstream myDumpBuffer; ///< intermediate buffer to store dumping data
349 std::ostringstream myFullDump; ///< full buffer of dumped data
351 ModulesMap myModules; ///< modules and entities to be imported
352 EntityNameMap myNames; ///< names of the entities
353 DumpStack myEntitiesStack; ///< stack of dumped entities
355 NbFeaturesMap myFeatureCount; ///< number of features of each kind
357 /// features which should not be dumped (like coincidence and tangency created by tangent arc)
358 std::set<FeaturePtr> myFeaturesToSkip;
360 std::list<EntityPtr> myPostponed; ///< list of postponed entities (sketch constraints or folders)
361 bool myDumpPostponedInProgress; ///< processing postponed is in progress
363 bool myGeometricalSelection; ///< dump selection not by naming, but by coordinates of inner point
366 /// list of entities, used by other features but not dumped yet
367 std::set<EntityPtr> myNotDumpedEntities;
369 friend class SketchAPI_Sketch;
370 friend class ModelHighAPI_Folder;