X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelHighAPI%2FModelHighAPI_Dumper.h;h=b9478e61c2c00321c44acf6730943678c62adde0;hb=e675b9eb8df755fff9763560ddf36d5bfeb6fe35;hp=11b6775a8e7f4fd481a78219bfac9c7b0a5fdae2;hpb=fb487c9f05bad69b5091b2eefdf4c0ef019c46d6;p=modules%2Fshaper.git diff --git a/src/ModelHighAPI/ModelHighAPI_Dumper.h b/src/ModelHighAPI/ModelHighAPI_Dumper.h index 11b6775a8..b9478e61c 100644 --- a/src/ModelHighAPI/ModelHighAPI_Dumper.h +++ b/src/ModelHighAPI/ModelHighAPI_Dumper.h @@ -1,8 +1,22 @@ -// Copyright (C) 2016-20xx CEA/DEN, EDF R&D --> - -// File: ModelHighAPI_Dumper.h -// Created: 1 August 2016 -// Author: Artem ZHIDKOV +// Copyright (C) 2014-2017 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,6 +49,7 @@ class ModelAPI_AttributeRefList; class ModelAPI_AttributeSelection; class ModelAPI_AttributeSelectionList; class ModelAPI_AttributeString; +class ModelAPI_AttributeStringArray; class ModelAPI_CompositeFeature; class ModelAPI_Document; class ModelAPI_Entity; @@ -76,17 +91,22 @@ 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) + /// \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()); /// Returns name of specified entity /// \param theEntity [in] named entity - /// \param theSaveNotDumped [in] if \c true, the entity should be stored as not dumped (will be dumped automatically) + /// \param theSaveNotDumped [in] + /// if \c true, the entity should be stored as not dumped (will be dumped automatically) + /// \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 MODELHIGHAPI_EXPORT @@ -97,10 +117,26 @@ public: /// Dump given feature virtual void dumpFeature(const FeaturePtr& theFeature, const bool theForce = false) = 0; + /// 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. + /// \param theSubFeatureGet [in] method for getting sub-feature (e.g. "Feature_1.subFeature(0)") + /// \param theSubFeature [in] sub-feature + MODELHIGHAPI_EXPORT + void dumpSubFeatureNameAndColor(const std::string theSubFeatureGet, + const FeaturePtr& theSubFeature); + /// Return name of getter for corresponding attribute virtual std::string attributeGetter(const FeaturePtr& theFeature, const std::string& theAttrName) const = 0; + /// 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); @@ -127,7 +163,7 @@ public: friend MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper, - std::basic_ostream& (*theEndl)(std::basic_ostream&)); + std::basic_ostream& (*theEndl)(std::basic_ostream&)); /// Dump GeomAPI_Pnt in the following form: /// "GeomAPI_Pnt(X, Y, Z)" @@ -172,32 +208,35 @@ public: ModelHighAPI_Dumper& operator<<(const ResultPtr& theResult); /// Dump Attribute - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theAttr); + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theAttr); /// Dump Object - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theObject); + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theObject); /// Dump AttributeRefAttr - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theRefAttr); + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theRefAttr); /// Dump AttributeRefAttrList as follows: /// "[obj1, obj2, obj3, ...]" - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theRefAttrList); + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theRefAttrList); /// Dump AttributeRefList as follows: /// "[obj1, obj2, obj3, ...]" - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theRefList); + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theRefList); /// Dump AttributeSelection - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theAttrSelect); + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theAttrSelect); /// Dump AttributeSelectionList - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theAttrSelList); + MODELHIGHAPI_EXPORT ModelHighAPI_Dumper& + operator<<(const std::shared_ptr& theAttrSelList); /// Dump AttributeReference - MODELHIGHAPI_EXPORT - ModelHighAPI_Dumper& operator<<(const std::shared_ptr& theReference); + 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 @@ -217,13 +256,15 @@ 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); /// 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 theDumpModelDo = false); + bool processSubs(const std::shared_ptr& theComposite, + bool theDumpModelDo = false); /// Check the entity is already dumped bool isDumped(const EntityPtr& theEntity) const; @@ -231,18 +272,42 @@ private: /// Stores names of results for the given feature void saveResultNames(const FeaturePtr& theFeature); + /// Check the result feature has default color + bool isDefaultColor(const ResultPtr& theResult) const; + + /// Check the result feature has default deflection + bool isDefaultDeflection(const ResultPtr& theResult) const; + private: - typedef std::map > EntityNameMap; - typedef std::map > ModulesMap; - typedef std::map > NbFeaturesMap; + 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), + myIsDumped(false) + {} + }; - struct LastDumpedEntity { - EntityPtr myEntity; // last dumped entity - bool myUserName; // the entity hase user-defined name - std::list myResultsWithName; // results of this entity, which has user-defined names + typedef std::map EntityNameMap; + typedef std::map > ModulesMap; + typedef std::map > NbFeaturesMap; - LastDumpedEntity(EntityPtr theEntity, bool theUserName, const std::list& theResults) - : myEntity(theEntity), myUserName(theUserName), myResultsWithName(theResults) + 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; + + LastDumpedEntity(EntityPtr theEntity, bool theUserName, + const std::list& theResults) + : myEntity(theEntity), myUserName(theUserName), myResults(theResults) {} }; typedef std::stack DumpStack; @@ -258,8 +323,12 @@ private: 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; + protected: - std::set myNotDumpedEntities; ///< list of entities, used by other features but not dumped yet + /// list of entities, used by other features but not dumped yet + std::set myNotDumpedEntities; friend class SketchAPI_Sketch; };