]> SALOME platform Git repositories - modules/kernel.git/commitdiff
Salome HOME
Add comments. TG_DumpPython_Extension_3_1
authorrnv <rnv@opencascade.com>
Mon, 8 Dec 2008 14:44:10 +0000 (14:44 +0000)
committerrnv <rnv@opencascade.com>
Mon, 8 Dec 2008 14:44:10 +0000 (14:44 +0000)
src/KERNEL_PY/salome_notebook.py

index efb0279eb8ddf61b74d50e9c542a55083883fca4..cdc5a5ad16f9ed1cb7d66d16c272eb42551de7d1 100644 (file)
@@ -35,6 +35,10 @@ class NoteBook:
         self.myStudy = Study
     
     def set(self, variableName, variable):
+       """
+       Create (or modify) variable with name "variableName" 
+       and value equal "theValue".
+       """
         if type(variable) == float:
             self.myStudy.SetReal(variableName, variable)
             
@@ -45,6 +49,9 @@ class NoteBook:
             self.myStudy.SetBoolean(variableName, variable)
             
     def get(self, variableName):
+       """
+       Return value of the variable with name "variableName".
+       """
         aResult = None
         if self.myStudy.IsVariable(variableName):
             
@@ -59,7 +66,11 @@ class NoteBook:
                 
         return aResult
     
-    def isVariable(self, variableName):
+    def isVariable(self, variableName): 
+       """
+       Return true if variable with name "variableName" 
+       exists in the study, otherwise return false.
+       """
         return self.myStudy.IsVariable(variableName)
                 
-notebook = NoteBook(salome.myStudy)
+notebook = NoteBook(salome.myStudy)
\ No newline at end of file