src/PYHELLO/PYHELLO.py

   1 # Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 #
   6 # This library is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU Lesser General Public
   8 # License as published by the Free Software Foundation; either
   9 # version 2.1 of the License, or (at your option) any later version.
  10 #
  11 # This library is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # Lesser General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU Lesser General Public
  17 # License along with this library; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 #
  20 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 #
  22
  23 # ---
  24 # File   : PYHELLOGUI.py
  25 # Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
  26 # ---
  27 #
  28 import PYHELLO_ORB__POA
  29 import SALOME_ComponentPy
  30 import SALOME_DriverPy
  31 import SALOMEDS
  32 from SALOME_DataContainerPy import *
  33
  34 from PYHELLO_utils import *
  35
  36 class PYHELLO(PYHELLO_ORB__POA.PYHELLO_Gen,
  37               SALOME_ComponentPy.SALOME_ComponentPy_i,
  38               SALOME_DriverPy.SALOME_DriverPy_i):
  39     """
  40     Construct an instance of PYHELLO module engine.
  41     The class PYHELLO implements CORBA interface PYHELLO_Gen (see PYHELLO_Gen.idl).
  42     It is inherited from the classes SALOME_ComponentPy_i (implementation of
  43     Engines::EngineComponent CORBA interface - SALOME component) and SALOME_DriverPy_i
  44     (implementation of SALOMEDS::Driver CORBA interface - SALOME module's engine).
  45     """
  46     def __init__ ( self, orb, poa, contID, containerName, instanceName,
  47                    interfaceName ):
  48         SALOME_ComponentPy.SALOME_ComponentPy_i.__init__(self, orb, poa,
  49                     contID, containerName, instanceName, interfaceName, 0)
  50         SALOME_DriverPy.SALOME_DriverPy_i.__init__(self, interfaceName)
  51         #
  52         self._naming_service = SALOME_ComponentPy.SALOME_NamingServicePy_i( self._orb )
  53         #
  54         pass
  55
  56     """
  57     Get version information.
  58     """
  59     def getVersion( self ):
  60         import salome_version
  61         return salome_version.getVersion("PYHELLO", True)
  62
  63     """
  64     Generate hello banner.
  65     """
  66     def makeBanner( self, name ):
  67         banner = "Hello %s!" % name
  68         return banner
  69
  70     """
  71     Intentionnally raises an exception for test purposes.
  72     """
  73     def raiseAnException( self ):
  74         import SALOME
  75         exData = SALOME.ExceptionStruct( SALOME.BAD_PARAM, "Test exception in raiseAnException()",'',0)
  76         raise SALOME.SALOME_Exception( exData )
  77
  78     """
  79     Create object.
  80     """
  81     def createObject( self, study, name ):
  82         self._createdNew = True # used for getModifiedData method
  83         builder = study.NewBuilder()
  84         father  = findOrCreateComponent( study )
  85         object  = builder.NewObject( father )
  86         attr    = builder.FindOrCreateAttribute( object, "AttributeName" )
  87         attr.SetValue( name )
  88         attr    = builder.FindOrCreateAttribute( object, "AttributeLocalID" )
  89         attr.SetValue( objectID() )
  90         pass
  91
  92     """
  93     Dump module data to the Python script.
  94     """
  95     def DumpPython( self, study, isPublished, isMultiFile ):
  96         abuffer = []
  97         names = []
  98         father = study.FindComponent( moduleName() )
  99         if father:
 100             iter = study.NewChildIterator( father )
 101             while iter.More():
 102                 name = iter.Value().GetName()
 103                 if name: names.append( name )
 104                 iter.Next()
 105                 pass
 106             pass
 107         if names:
 108             abuffer += [ "from salome import lcc" ]
 109             abuffer += [ "import PYHELLO_ORB" ]
 110             abuffer += [ "" ]
 111             abuffer += [ "pyhello = lcc.FindOrLoadComponent( 'FactoryServerPy', '%s' )" % moduleName() ]
 112             abuffer += [ "" ]
 113             abuffer += [ "pyhello.createObject( theStudy, '%s' )" % name for name in names ]
 114             abuffer += [ "" ]
 115             pass
 116         if isMultiFile:
 117             abuffer       = [ "  " + s for s in abuffer ]
 118             abuffer[0:0]  = [ "def RebuildData( theStudy ):" ]
 119             abuffer      += [ "  pass" ]
 120         abuffer += [ "\0" ]
 121         return ("\n".join( abuffer ), 1)
 122
 123     """
 124     Import file to restore module data
 125     """
 126     def importData(self, studyId, dataContainer, options):
 127       # get study by Id
 128       obj = self._naming_service.Resolve("myStudyManager")
 129       myStudyManager = obj._narrow(SALOMEDS.StudyManager)
 130       study = myStudyManager.GetStudyByID(studyId)
 131       # create all objects from the imported stream
 132       stream = dataContainer.get()
 133       for objname in stream.split("\n"):
 134         if len(objname) != 0:
 135           self.createObject(study, objname)
 136       self._createdNew = False # to store the modification of the study information later
 137       return ["objects"] # identifier what is in this file
 138
 139     def getModifiedData(self, studyId):
 140       if self._createdNew:
 141         # get study by Id
 142         obj = self._naming_service.Resolve("myStudyManager")
 143         myStudyManager = obj._narrow(SALOMEDS.StudyManager)
 144         study = myStudyManager.GetStudyByID(studyId)
 145         # iterate all objects to get their names and store this information in stream
 146         stream=""
 147         father = study.FindComponent( moduleName() )
 148         if father:
 149             iter = study.NewChildIterator( father )
 150             while iter.More():
 151                 name = iter.Value().GetName()
 152                 stream += name + "\n"
 153                 iter.Next()
 154         # store stream to the temporary file to send it in DataContainer
 155         dataContainer = SALOME_DataContainerPy_i(stream, "", "objects", False, True)
 156         aVar = dataContainer._this()
 157         return [aVar]
 158       return []