1 # Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
3 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 # Author : Paul RASCLE, EDF
28 def __init__(self, aDoc):
37 module salome gives access to Salome ressources:
41 salome.naming_service : instance of naming Service class
43 Resolve(name) : find a CORBA object (ior) by its pathname
44 Register(name) : register a CORBA object under a pathname
45 salome.lcc : instance of lifeCycleCORBA class
47 FindOrLoadComponent(server,name) :
48 obtain an Engine (CORBA object)
49 or launch the Engine if not found,
50 with a Server name and an Engine name
53 updateObjBrowser(bool):
57 SelectedCount(): returns number of selected objects
58 getSelected(i): returns entry of selected object number i
59 getAllSelected(): returns list of entry of selected objects
60 AddIObject(Entry): select an existing Interactive object
61 RemoveIObject(Entry): remove object from selection
62 ClearIObjects(): clear selection
70 IDToObject(Entry): returns CORBA reference from entry
72 salome.myStudyName : active Study Name
73 salome.myStudyId : active Study Id
74 salome.myStudy : the active Study itself (CORBA ior)
75 methods : defined in SALOMEDS.idl
78 salome.DumpStudy(study) : Dump a study, given the ior
87 module geompy provides an encapsulation of GEOM Engine methods
89 geompy.geom : a Geometry Engine, found or loaded
90 at first import of module geompy.
91 methods : defined in GEOM_Gen.idl
92 geompy.myBuilder : a study builder
93 geompy.father : GEOM root in current study (salome.myStudy)
96 addToStudy(aShape, aName) : add the shape into the current study
97 --- all methods of GEOM_Gen.idl that returns a shape are encapsulated,
98 with the same interface : shapes are named with their ior
102 def supervision(self):
103 doc_supervision = '''
104 MODULES : SALOME_SuperVisionEditor and SALOME_SuperVisionExecutor
105 -----------------------------------------------------------------
106 this modules provide access to Editor and Executor Engine methods
110 In order to run the example (supervisionexample.py)
112 Type : from supervisionexample import *
113 supervisionexample.py contains comments
115 A new python example avoids references to LifeCycleCORBA
116 avoids references to NamingService
117 avoids references to ModuleCatalog
118 avoids SuperVisionComponent creation
119 allows G.Input(...) instead of AddInput(G,...)
120 replaces Editor/Executor with Graph
121 allows Nodes, Ports and Links CORBA objects
122 shortens methods names
125 See /SuperVisionTest/resources/GraphExample.py
129 print doc_supervision
135 salome : gives access to Salome ressources
136 geompy : encapsulation of GEOM Engine methods
137 supervision : gives access to SuperVision Engine
138 To obtain specific help on a module "truc", type: Help.truc()
139 To run an example, type: import example3