src/PythonAPI/model/roots.py

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