src/PythonAPI/model/roots.py

   1 # Copyright (C) 2014-2020  CEA/DEN, EDF R&D
   2 #
   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.
   7 #
   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.
  12 #
  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
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 """Abstract root classes of user-defined Python features producing a Body
  21 Author: Daniel Brunier-Coulin
  22 """
  23
  24 import ModelAPI
  25
  26 class Feature(ModelAPI.ModelAPI_Feature):
  27     """Base class of user-defined Python features."""
  28
  29     def __init__(self):
  30         """x.__init__(...) initializes x; see x.__class__.__doc__ for signature"""
  31         ModelAPI.ModelAPI_Feature.__init__(self)
  32
  33     def addRealInput(self, inputid):
  34         """F.addRealInput(str) -- add real attribute"""
  35         self.data().addAttribute(inputid,
  36                                  ModelAPI.ModelAPI_AttributeDouble_typeId())
  37
  38     def getRealInput(self, inputid):
  39         """F.getRealInput(str) -- get real value of the attribute"""
  40         return self.data().real(inputid).value()
  41
  42     def getTextInput(self, inputid):
  43         """F.getTextInput(str) -- get text value of the attribute"""
  44         return self.data().real(inputid).text()
  45
  46     def addResult(self, result):
  47         """F.addResult(ModelAPI_Result) -- add ModelAPI_Result shape as a result"""
  48         shape = result.shape()
  49         body = self.document().createBody(self.data())
  50         body.store(shape)
  51         self.setResult(body)
  52