2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
5 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
8 # This library is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU Lesser General Public
10 # License as published by the Free Software Foundation; either
11 # version 2.1 of the License.
13 # This library is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 # Lesser General Public License for more details.
18 # You should have received a copy of the GNU Lesser General Public
19 # License along with this library; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
25 # Author : Paul RASCLE, EDF
30 def __init__(self, aDoc):
39 module salome gives access to Salome ressources:
43 salome.naming_service : instance of naming Service class
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
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
55 updateObjBrowser(bool):
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
72 IDToObject(Entry): returns CORBA reference from entry
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
80 salome.DumpStudy(study) : Dump a study, given the ior
89 module geompy provides an encapsulation of GEOM Engine methods
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)
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
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
112 In order to run the example (supervisionexample.py)
114 Type : from supervisionexample import *
115 supervisionexample.py contains comments
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
127 See /SuperVisionTest/resources/GraphExample.py
131 print doc_supervision
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