+# Copyright (C) 2014-2022 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
+#
+
"""Abstract root classes of user-defined Python features producing a Body
Author: Daniel Brunier-Coulin
-Copyright (C) 2014-20xx CEA/DEN, EDF R&D
"""
import ModelAPI
-from .tools import get_value, convert_to_underscore
-
-
class Feature(ModelAPI.ModelAPI_Feature):
"""Base class of user-defined Python features."""
def __init__(self):
+ """x.__init__(...) initializes x; see x.__class__.__doc__ for signature"""
ModelAPI.ModelAPI_Feature.__init__(self)
- def addRealInput (self, inputid):
+ def addRealInput(self, inputid):
+ """F.addRealInput(str) -- add real attribute"""
self.data().addAttribute(inputid,
ModelAPI.ModelAPI_AttributeDouble_typeId())
- def getRealInput (self, inputid):
+ def getRealInput(self, inputid):
+ """F.getRealInput(str) -- get real value of the attribute"""
return self.data().real(inputid).value()
- def addResult (self, result):
+ def getTextInput(self, inputid):
+ """F.getTextInput(str) -- get text value of the attribute"""
+ return self.data().real(inputid).text()
+
+ def addResult(self, result):
+ """F.addResult(ModelAPI_Result) -- add ModelAPI_Result shape as a result"""
shape = result.shape()
body = self.document().createBody(self.data())
body.store(shape)
self.setResult(body)
-
-class Interface():
- """Base class of high level Python interfaces to features."""
-
- def __init__(self, feature):
- self._feature = feature
- self._attribute_white_list = [
- "getKind", "results", "firstResult", "lastResult",
- ]
-
- def __getattr__(self, name):
- """Process missing attributes.
-
- Add get*() methods for access feature attributes.
- Redirect some missing attributes to the feature.
- """
- if name.startswith("get"):
- possible_names = [
- "_" + name[3:],
- "_" + convert_to_underscore(name[3:]),
- ]
- for possible_name in possible_names:
- if hasattr(self, possible_name):
- def getter():
- return getattr(self, possible_name)
- return getter
-
- if name in self._attribute_white_list:
- return getattr(self._feature, name)
-
- raise AttributeError()
-
- def feature(self):
- """Return ModelAPI_Feature."""
- return self._feature
-
- def setRealInput(self, inputid, value):
- self._feature.data().real(inputid).setValue(value)
-
- def areInputValid(self):
- validators = ModelAPI.ModelAPI_Session.get().validators()
- return validators.validate(self._feature)
-
- def execute(self):
- self._feature.execute()
