X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelHighAPI%2FModelHighAPI_Dumper.h;h=2bbc294357441c7a74ef484ec8124b9ce3b68811;hb=8d04b5f4360b23cf376beff9c5e7c12d0e6a5f1e;hp=ace8be67aa5eef858e7157cf15a33445b96928dc;hpb=0bada2df7b7948c756effe42fe860cc1b93b77af;p=modules%2Fshaper.git diff --git a/src/ModelHighAPI/ModelHighAPI_Dumper.h b/src/ModelHighAPI/ModelHighAPI_Dumper.h index ace8be67a..2bbc29435 100644 --- a/src/ModelHighAPI/ModelHighAPI_Dumper.h +++ b/src/ModelHighAPI/ModelHighAPI_Dumper.h @@ -1,8 +1,21 @@ -// Copyright (C) 2016-20xx CEA/DEN, EDF R&D --> - -// File: ModelHighAPI_Dumper.h -// Created: 1 August 2016 -// Author: Artem ZHIDKOV +// Copyright (C) 2014-2019 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef ModelHighAPI_Dumper_H_ #define ModelHighAPI_Dumper_H_ @@ -35,24 +48,94 @@ class ModelAPI_AttributeRefList; class ModelAPI_AttributeSelection; class ModelAPI_AttributeSelectionList; class ModelAPI_AttributeString; +class ModelAPI_AttributeStringArray; class ModelAPI_CompositeFeature; class ModelAPI_Document; class ModelAPI_Entity; class ModelAPI_Feature; +class ModelAPI_Folder; class ModelAPI_Object; class ModelAPI_Result; typedef std::shared_ptr DocumentPtr; typedef std::shared_ptr EntityPtr; typedef std::shared_ptr FeaturePtr; +typedef std::shared_ptr FolderPtr; typedef std::shared_ptr ResultPtr; +typedef std::set ModulesSet; +typedef std::map > > NbFeaturesMap; + /**\class ModelHighAPI_Dumper * \ingroup CPPHighAPI * \brief Dump engine for the model + * + * The dumper can be customized by the set of storages (DumpStorage), for example to identify + * dumped selected objects by their geometrical properties. By default, the dump is executed to + * store original names of the selected shapes. */ class ModelHighAPI_Dumper { +public: + /** \class DumpStorage + * \ingroup CPPHighAPI + * \brief Storage for the dumped data. Process selection attributes to be dumped by naming. + */ + class DumpStorage + { + public: + DumpStorage() {} + MODELHIGHAPI_EXPORT DumpStorage(const DumpStorage& theOther); + MODELHIGHAPI_EXPORT const DumpStorage& operator=(const DumpStorage& theOther); + + void setFilenameSuffix(const std::string& theSuffix) { myFilenameSuffix = theSuffix; } + + protected: + std::ostringstream& buffer() { return myDumpBuffer; } + std::ostringstream& fullDump() { return myFullDump; } + + MODELHIGHAPI_EXPORT virtual void reserveBuffer(); + MODELHIGHAPI_EXPORT virtual void restoreReservedBuffer(); + + MODELHIGHAPI_EXPORT + virtual void write(const std::shared_ptr& theAttrSelect); + + MODELHIGHAPI_EXPORT + virtual bool exportTo(const std::string& theFilename, const ModulesSet& theUsedModules); + + private: + std::string myFilenameSuffix; + std::ostringstream myDumpBuffer; + std::ostringstream myFullDump; + + std::stack myDumpBufferHideout; + + friend class ModelHighAPI_Dumper; + }; + typedef std::shared_ptr DumpStoragePtr; + + /** \class DumpStorageGeom + * \ingroup CPPHighAPI + * \brief Process selection attributes to be dumped by geometric properties. + */ + class DumpStorageGeom : public DumpStorage + { + protected: + MODELHIGHAPI_EXPORT + virtual void write(const std::shared_ptr& theAttrSelect); + }; + + /** \class DumpStorageWeak + * \ingroup CPPHighAPI + * \brief Process selection attributes to be dumped by weak naming. + */ + class DumpStorageWeak : public DumpStorage + { + protected: + MODELHIGHAPI_EXPORT + virtual void write(const std::shared_ptr& theAttrSelect); + }; + public: /// Default constructor MODELHIGHAPI_EXPORT @@ -67,7 +150,15 @@ public: static ModelHighAPI_Dumper* getInstance(); /// Destructor - virtual ~ModelHighAPI_Dumper() {} + MODELHIGHAPI_EXPORT + virtual ~ModelHighAPI_Dumper(); + + /// Add custom storage to collect corresponding dump + MODELHIGHAPI_EXPORT + void addCustomStorage(const DumpStoragePtr& theStorage); + /// Clear custom storages list + MODELHIGHAPI_EXPORT + void clearCustomStorage(); /// Dump given document into the file /// \return \c true, if succeed @@ -76,21 +167,18 @@ public: /// Add module to list of imported modules /// \param theModuleName name of the module to be imported - /// \param theObject name of the entity to be imported - /// from the module (if empty, while module will be imported) MODELHIGHAPI_EXPORT - void importModule(const std::string& theModuleName, - const std::string& theObject = std::string()); + void importModule(const std::string& theModuleName); /// Returns name of specified entity /// \param theEntity [in] named entity - /// \param theSaveNotDumped [in] + /// \param theSaveNotDumped [in] /// if \c true, the entity should be stored as not dumped (will be dumped automatically) - /// \param theUseEntityName [in] + /// \param theUseEntityName [in] /// if \c true, the entity name should be used "as is" without changing default name /// \return name of the entity MODELHIGHAPI_EXPORT - const std::string& name(const EntityPtr& theEntity, bool theSaveNotDumped = true, + const std::string& name(const EntityPtr& theEntity, bool theSaveNotDumped = true, bool theUseEntityName = false); /// Returns name of parent composite feature for specified entity @@ -101,6 +189,18 @@ public: virtual void dumpParameter(const FeaturePtr& theFeature) = 0; /// Dump given feature virtual void dumpFeature(const FeaturePtr& theFeature, const bool theForce = false) = 0; + /// Dump folder + virtual void dumpFolder(const FolderPtr& theFolder) = 0; + + /// Set feature postponed until all its dependencies are not dumped. + /// The name of the feature is stored anyway. + MODELHIGHAPI_EXPORT + void postpone(const EntityPtr& theEntity); + + /// Set a feature that should not be dumped anyway + MODELHIGHAPI_EXPORT + void doNotDumpFeature(const FeaturePtr& theFeature) + { myFeaturesToSkip.insert(theFeature); } /// Dump sub-feature name and color, without dumping feature creation. /// Used for features which creates sub-features in their execute method. @@ -117,10 +217,6 @@ public: /// Return name of wrapper feature virtual std::string featureWrapper(const FeaturePtr& theFeature) const = 0; - /// Save all dumps into specified file - MODELHIGHAPI_EXPORT - bool exportTo(const std::string& theFileName); - /// Dump character MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const char theChar); @@ -183,44 +279,62 @@ public: MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const FeaturePtr& theEntity); + /// Dump folder + MODELHIGHAPI_EXPORT + ModelHighAPI_Dumper& operator<<(const FolderPtr& theFolder); + /// Dump result MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const ResultPtr& theResult); + /// Dump a list of results + MODELHIGHAPI_EXPORT + ModelHighAPI_Dumper& operator<<(const std::list& theResults); + /// Dump Attribute - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theAttr); /// Dump Object - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theObject); /// Dump AttributeRefAttr - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theRefAttr); /// Dump AttributeRefAttrList as follows: /// "[obj1, obj2, obj3, ...]" - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theRefAttrList); /// Dump AttributeRefList as follows: /// "[obj1, obj2, obj3, ...]" - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theRefList); /// Dump AttributeSelection - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theAttrSelect); /// Dump AttributeSelectionList - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theAttrSelList); /// Dump AttributeReference - MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theReference); + /// Dump AttributeStringArray + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theArray); - /// Clear dump buffer - MODELHIGHAPI_EXPORT - void clear(bool bufferOnly = false); /// clear list of not dumped entities MODELHIGHAPI_EXPORT void clearNotDumped(); + /// Check the entity is already dumped + MODELHIGHAPI_EXPORT + bool isDumped(const EntityPtr& theEntity) const; + /// Check theRefAttr is already dumped + MODELHIGHAPI_EXPORT + bool isDumped(const std::shared_ptr& theRefAttr) const; + /// Check all objects in theRefList are already dumped + MODELHIGHAPI_EXPORT + bool isDumped(const std::shared_ptr& theRefList) const; + protected: /// Dump "setName" command if last entity had user-defined name MODELHIGHAPI_EXPORT void dumpEntitySetName(); @@ -233,19 +347,17 @@ private: bool process(const std::shared_ptr& theDoc); /// Dump composite feature and all it sub-features - bool process(const std::shared_ptr& theComposite, - bool isForce = false); + bool process(const std::shared_ptr& theComposite, + bool isForce = false, + bool isDumpModelDo = true); /// Iterate all features in composite feature and dump them into intermediate buffer /// \param theComposite [in] parent composite feature /// \param theDumpModelDo [in] shows that command "model.do()" should be written at the end MODELHIGHAPI_EXPORT - bool processSubs(const std::shared_ptr& theComposite, + bool processSubs(const std::shared_ptr& theComposite, bool theDumpModelDo = false); - /// Check the entity is already dumped - bool isDumped(const EntityPtr& theEntity) const; - /// Stores names of results for the given feature void saveResultNames(const FeaturePtr& theFeature); @@ -255,52 +367,66 @@ private: /// Check the result feature has default deflection bool isDefaultDeflection(const ResultPtr& theResult) const; + /// Check the result feature has default transparency + bool isDefaultTransparency(const ResultPtr& theResult) const; + + /// Dump postponed entities + void dumpPostponed(bool theDumpFolders = false); + private: struct EntityName { std::string myCurrentName; ///< default name of current feature std::string myUserName; ///< user-defined name bool myIsDefault; ///< \c true if the name is default + bool myIsDumped; ///< shows that the names of the feature are already stored EntityName() {} EntityName(const std::string& theCurName, const std::string& theUserName, bool theDefault) - : myCurrentName(theCurName), myUserName(theUserName), myIsDefault(theDefault) + : myCurrentName(theCurName), + myUserName(theUserName), + myIsDefault(theDefault), + myIsDumped(false) {} }; - - typedef std::map EntityNameMap; - typedef std::map > ModulesMap; - typedef std::map > NbFeaturesMap; + typedef std::map EntityNameMap; struct LastDumpedEntity { EntityPtr myEntity; ///< last dumped entity bool myUserName; ///< the entity hase user-defined name /// results of this entity, which has user-defined names or specific colors - std::list myResults; + std::list myResults; - LastDumpedEntity(EntityPtr theEntity, bool theUserName, - const std::list& theResults) + LastDumpedEntity(EntityPtr theEntity, bool theUserName, + const std::list& theResults = std::list()) : myEntity(theEntity), myUserName(theUserName), myResults(theResults) {} }; - typedef std::stack DumpStack; + typedef std::stack DumpStack; static ModelHighAPI_Dumper* mySelf; - std::ostringstream myDumpBuffer; ///< intermediate buffer to store dumping data - std::ostringstream myFullDump; ///< full buffer of dumped data + class DumpStorageBuffer; + DumpStorageBuffer* myDumpStorage; ///< storage of dumped data - ModulesMap myModules; ///< modules and entities to be imported + ModulesSet myModules; ///< modules and entities to be imported EntityNameMap myNames; ///< names of the entities DumpStack myEntitiesStack; ///< stack of dumped entities NbFeaturesMap myFeatureCount; ///< number of features of each kind + /// features which should not be dumped (like coincidence and tangency created by tangent arc) + std::set myFeaturesToSkip; + + std::list myPostponed; ///< list of postponed entities (sketch constraints or folders) + bool myDumpPostponedInProgress; ///< processing postponed is in progress + protected: - /// list of entities, used by other features but not dumped yet - std::set myNotDumpedEntities; + /// list of entities, used by other features but not dumped yet + std::set myNotDumpedEntities; friend class SketchAPI_Sketch; + friend class ModelHighAPI_Folder; }; #endif