1 #==============================================================================
3 # Created : sam nov 10 16:51:38 CET 2001
4 # Author : Paul RASCLE, EDF
8 #==============================================================================
11 def __init__(self, aDoc):
20 module salome gives access to Salome ressources:
24 salome.naming_service : instance of naming Service class
26 Resolve(name) : find a CORBA object (ior) by its pathname
27 Register(name) : register a CORBA object under a pathname
28 salome.lcc : instance of lifeCycleCORBA class
30 FindOrLoadComponent(server,name) :
31 obtain an Engine (CORBA object)
32 or launch the Engine if not found,
33 with a Server name and an Engine name
36 updateObjBrowser(bool):
40 SelectedCount(): returns number of selected objects
41 getSelected(i): returns entry of selected object number i
42 getAllSelected(): returns list of entry of selected objects
43 AddIObject(Entry): select an existing Interactive object
44 RemoveIObject(Entry): remove object from selection
45 ClearIObjects(): clear selection
53 IDToObject(Entry): returns CORBA reference from entry
55 salome.myStudyName : active Study Name
56 salome.myStudyId : active Study Id
57 salome.myStudy : the active Study itself (CORBA ior)
58 methods : defined in SALOMEDS.idl
61 salome.DumpStudy(study) : Dump a study, given the ior
70 module geompy provides an encapsulation of GEOM Engine methods
72 geompy.geom : a Geometry Engine, found or loaded
73 at first import of module geompy.
74 methods : defined in GEOM_Gen.idl
75 geompy.myBuilder : a study builder
76 geompy.father : GEOM root in current study (salome.myStudy)
79 addToStudy(aShape, aName) : add the shape into the current study
80 --- all methods of GEOM_Gen.idl that returns a shape are encapsulated,
81 with the same interface : shapes are named with their ior
85 def supervision(self):
87 MODULES : SALOME_SuperVisionEditor and SALOME_SuperVisionExecutor
88 -----------------------------------------------------------------
89 this modules provide access to Editor and Executor Engine methods
93 In order to run the example (supervisionexample.py)
95 Type : from supervisionexample import *
96 supervisionexample.py contains comments
98 A new python example avoids references to LifeCycleCORBA
99 avoids references to NamingService
100 avoids references to ModuleCatalog
101 avoids SuperVisionComponent creation
102 allows G.Input(...) instead of AddInput(G,...)
103 replaces Editor/Executor with Graph
104 allows Nodes, Ports and Links CORBA objects
105 shortens methods names
108 See /SuperVisionTest/resources/GraphExample.py
112 print doc_supervision
118 salome : gives access to Salome ressources
119 geompy : encapsulation of GEOM Engine methods
120 supervision : gives access to SuperVision Engine
121 To obtain specific help on a module "truc", type: help.truc()
122 To run an example, type: import example3