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 """Package for dumping purposes.
33 instance.__call__ = lambda: instance
37 ## @ingroup CPPHighAPI
38 # Collect information about features that may be dumped and stores the model as a Python script
40 class DumpAssistant(ModelHighAPI.ModelHighAPI_Dumper):
44 ModelHighAPI.ModelHighAPI_Dumper.__init__(self)
45 ModelHighAPI.ModelHighAPI_Dumper.setInstance(self)
46 self.collectFeatures()
49 ## Collect feature wrappers, which allow dumping (have method dump)
50 def collectFeatures(self):
52 self.myWrapperNames = {}
53 for aModule in sys.modules:
54 for aName, anObj in inspect.getmembers(sys.modules[aModule], inspect.isclass):
55 if issubclass(anObj, ModelHighAPI.ModelHighAPI_Interface) and hasattr(anObj, "ID") and anObj.dump != ModelHighAPI.ModelHighAPI_Interface.dump:
56 self.myFeatures[anObj.ID()] = anObj
57 self.myWrapperNames[anObj.ID()] = aName
59 ## Create wrapper for a given feature and dump it
60 def dumpFeature(self, theFeature, theForce):
61 aFeatureKind = theFeature.getKind()
62 if aFeatureKind in self.myFeatures:
63 # Dump only feature created by user (in history).
64 # Also dump Export and RemoveResults features (hard-coded here in order not to change the data model).
65 # For all other features, just keep their name.
66 if theForce or theFeature.isInHistory() or aFeatureKind=="Export" or aFeatureKind=="RemoveResults":
67 self.myFeatures[aFeatureKind](theFeature).dump(self)
72 # Probably the feature is a constraint, try to dump it with SketchAPI_Constraint.
73 # In case of theFeature is not a constraint, it will not be dumped.
74 self.myFeatures[SketchAPI.SketchAPI_Constraint.ID()](theFeature).dump(self)
76 ## Create wrapper for a folder and dump it
77 def dumpFolder(self, theFolder):
78 if theFolder.ID() in self.myFeatures:
79 self.myFeatures[theFolder.ID()](theFolder).dump(self)
81 ## Dump all parameters
82 def dumpParameter(self, theFeature):
83 aFeatureKind = theFeature.getKind()
84 if aFeatureKind == "Parameter" and aFeatureKind in self.myFeatures:
85 self.myFeatures[aFeatureKind](theFeature).dump(self)
87 ## Return getter for specified attribute
88 def attributeGetter(self, theFeature, theAttrName):
89 aFeatureKind = theFeature.getKind()
90 if aFeatureKind in self.myFeatures:
91 return self.myFeatures[aFeatureKind](theFeature).attributeGetter(theAttrName)
94 ## Return name of wrapper feature
95 def featureWrapper(self, theFeature):
96 aFeatureKind = theFeature.getKind()
97 if aFeatureKind in self.myWrapperNames:
98 return self.myWrapperNames[aFeatureKind]
101 ## Exports the dumped variables names to the SHAPERSTUDY
102 def exportVariable(self, theEntry, theVarName):
104 if self.myEngine == None:
105 import SHAPERSTUDY_utils
106 aComponent = SHAPERSTUDY_utils.findOrCreateComponent()
107 self.myEngine = SHAPERSTUDY_utils.getEngine()
108 if self.myEngine != 1:
109 self.myEngine.StoreVariableName(theEntry, theVarName)
111 self.myEngine = 1 # invalid access
115 dumper = DumpAssistant