src/KERNEL_PY/Help.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23
  24 #  File   : Help.py
  25 #  Author : Paul RASCLE, EDF
  26 #  Module : SALOME
  27 #  $Header$
  28 #
  29 class SalomeDoc:
  30     def __init__(self, aDoc):
  31         self.doc = aDoc
  32     def __repr__(self):
  33         print self.doc
  34         return "---"
  35     def salome(self):
  36         doc_salome = '''
  37 MODULE : salome
  38 ---------------
  39 module salome gives access to Salome ressources:
  40 variables:
  41
  42   salome.orb             : CORBA
  43   salome.naming_service  : instance of naming Service class
  44       methods:
  45           Resolve(name)  : find a CORBA object (ior) by its pathname
  46           Register(name) : register a CORBA object under a pathname
  47   salome.lcc             : instance of lifeCycleCORBA class
  48       methods:
  49           FindOrLoadComponent(server,name) :
  50                            obtain an Engine (CORBA object)
  51                            or launch the Engine if not found,
  52                            with a Server name and an Engine name
  53   salome.sg
  54       methods:
  55          updateObjBrowser(bool):
  56          getActiveStudyId():
  57          getActiveStudyName():
  58
  59          SelectedCount():      returns number of selected objects
  60          getSelected(i):       returns entry of selected object number i
  61          getAllSelected():     returns list of entry of selected objects
  62          AddIObject(Entry):    select an existing Interactive object
  63          RemoveIObject(Entry): remove object from selection
  64          ClearIObjects():      clear selection
  65
  66          Display(*Entry):
  67          DisplayOnly(Entry):
  68          Erase(Entry):
  69          DisplayAll():
  70          EraseAll():
  71
  72          IDToObject(Entry):    returns CORBA reference from entry
  73
  74   salome.myStudyName     : active Study Name
  75   salome.myStudyId       : active Study Id
  76   salome.myStudy         : the active Study itself (CORBA ior)
  77                            methods : defined in SALOMEDS.idl
  78
  79 methods:
  80   salome.DumpStudy(study) : Dump a study, given the ior
  81 ---
  82 '''
  83         print doc_salome
  84
  85     def geompy(self):
  86         doc_geompy = '''
  87 MODULE : geompy
  88 ---------------
  89 module geompy provides an encapsulation of GEOM Engine methods
  90 variables:
  91   geompy.geom               : a Geometry Engine, found or loaded
  92                               at first import of module geompy.
  93                               methods : defined in GEOM_Gen.idl
  94   geompy.myBuilder          : a study builder
  95   geompy.father             : GEOM root in current study (salome.myStudy)
  96
  97 methods:
  98   addToStudy(aShape, aName) : add the shape into the current study
  99   --- all methods of GEOM_Gen.idl that returns a shape are encapsulated,
 100       with the same interface : shapes are named with their ior
 101 '''
 102         print doc_geompy
 103
 104     def supervision(self):
 105         doc_supervision = '''
 106 MODULES : SALOME_SuperVisionEditor and SALOME_SuperVisionExecutor
 107 -----------------------------------------------------------------
 108 this modules provide access to Editor and Executor Engine methods
 109
 110 See SUPERV.idl
 111
 112 In order to run the example (supervisionexample.py)
 113
 114     Type : from supervisionexample import *
 115            supervisionexample.py contains comments
 116
 117 A new python example avoids references to LifeCycleCORBA
 118                      avoids references to NamingService
 119                      avoids references to ModuleCatalog
 120                      avoids SuperVisionComponent creation
 121                      allows G.Input(...) instead of AddInput(G,...)
 122                      replaces Editor/Executor with Graph
 123                      allows Nodes, Ports and Links CORBA objects
 124                      shortens methods names
 125                      ...
 126
 127     See /SuperVisionTest/resources/GraphExample.py
 128                                    and GraphExample.xml
 129 ---
 130 '''
 131         print doc_supervision
 132
 133
 134
 135 Help = SalomeDoc('''
 136 Availables modules:
 137   salome      : gives access to Salome ressources
 138   geompy      : encapsulation of GEOM Engine methods
 139   supervision : gives access to SuperVision Engine
 140 To obtain specific help on a module "truc", type: Help.truc()
 141 To run an example, type: import example3
 142 ''')
 143