Back to index

salome-kernel  6.5.0
Public Member Functions | Public Attributes
KERNEL_PY.Help.SalomeDoc Class Reference

List of all members.

Public Member Functions

def __init__
def __repr__
def salome
def geompy
def supervision

Public Attributes

 doc

Detailed Description

Definition at line 29 of file Help.py.


Constructor & Destructor Documentation

def KERNEL_PY.Help.SalomeDoc.__init__ (   self,
  aDoc 
)

Definition at line 30 of file Help.py.

00030 
00031     def __init__(self, aDoc):
        self.doc = aDoc

Member Function Documentation

Definition at line 32 of file Help.py.

00032 
00033     def __repr__(self):
00034         print self.doc
        return "---"

Definition at line 85 of file Help.py.

00085 
00086     def geompy(self):
00087         doc_geompy = '''
00088 MODULE : geompy
00089 ---------------
00090 module geompy provides an encapsulation of GEOM Engine methods
00091 variables:
00092   geompy.geom               : a Geometry Engine, found or loaded
00093                               at first import of module geompy.
00094                               methods : defined in GEOM_Gen.idl
00095   geompy.myBuilder          : a study builder
00096   geompy.father             : GEOM root in current study (salome.myStudy)
00097 
00098 methods:
00099   addToStudy(aShape, aName) : add the shape into the current study
00100   --- all methods of GEOM_Gen.idl that returns a shape are encapsulated,
00101       with the same interface : shapes are named with their ior
00102 '''
00103         print doc_geompy
        

Definition at line 35 of file Help.py.

00035 
00036     def salome(self):
00037         doc_salome = '''
00038 MODULE : salome
00039 ---------------
00040 module salome gives access to Salome ressources:
00041 variables:
00042 
00043   salome.orb             : CORBA
00044   salome.naming_service  : instance of naming Service class
00045       methods:
00046           Resolve(name)  : find a CORBA object (ior) by its pathname
00047           Register(name) : register a CORBA object under a pathname
00048   salome.lcc             : instance of lifeCycleCORBA class
00049       methods:
00050           FindOrLoadComponent(server,name) :
00051                            obtain an Engine (CORBA object)
00052                            or launch the Engine if not found,
00053                            with a Server name and an Engine name
00054   salome.sg
00055       methods:
00056          updateObjBrowser(bool):
00057          getActiveStudyId():
00058          getActiveStudyName():
00059          
00060          SelectedCount():      returns number of selected objects
00061          getSelected(i):       returns entry of selected object number i
00062          getAllSelected():     returns list of entry of selected objects
00063          AddIObject(Entry):    select an existing Interactive object
00064          RemoveIObject(Entry): remove object from selection
00065          ClearIObjects():      clear selection
00066          
00067          Display(*Entry):
00068          DisplayOnly(Entry):
00069          Erase(Entry):
00070          DisplayAll():
00071          EraseAll():
00072 
00073          IDToObject(Entry):    returns CORBA reference from entry
00074 
00075   salome.myStudyName     : active Study Name
00076   salome.myStudyId       : active Study Id
00077   salome.myStudy         : the active Study itself (CORBA ior)
00078                            methods : defined in SALOMEDS.idl
00079                                                          
00080 methods:
00081   salome.DumpStudy(study) : Dump a study, given the ior
00082 ---
00083 '''
00084         print doc_salome
        

Definition at line 104 of file Help.py.

00104 
00105     def supervision(self):
00106         doc_supervision = '''
00107 MODULES : SALOME_SuperVisionEditor and SALOME_SuperVisionExecutor
00108 -----------------------------------------------------------------
00109 this modules provide access to Editor and Executor Engine methods
00110 
00111 See SUPERV.idl
00112 
00113 In order to run the example (supervisionexample.py)
00114 
00115     Type : from supervisionexample import *
00116            supervisionexample.py contains comments
00117 
00118 A new python example avoids references to LifeCycleCORBA
00119                      avoids references to NamingService
00120                      avoids references to ModuleCatalog
00121                      avoids SuperVisionComponent creation
00122                      allows G.Input(...) instead of AddInput(G,...)
00123                      replaces Editor/Executor with Graph
00124                      allows Nodes, Ports and Links CORBA objects
00125                      shortens methods names
00126                      ...
00127 
00128     See /SuperVisionTest/resources/GraphExample.py
00129                                    and GraphExample.xml
00130 ---
00131 '''
00132         print doc_supervision
00133         
00134     


Member Data Documentation

Definition at line 31 of file Help.py.


The documentation for this class was generated from the following file: