Version: 8.3.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
studyedit

Data Structures

class  studyedit.StudyEditor
 This class provides utility methods to complement Study and StudyBuilder classes. More...
 

Functions

def studyedit.getActiveStudyId
 Return the ID of the active study. More...
 
def studyedit.getStudyEditor
 Return a StudyEditor instance to edit the study with ID studyId. More...
 

Detailed Description

This module provides a new class to complement and classes.

Function Documentation

def studyedit.getActiveStudyId ( )

Return the ID of the active study.

In GUI mode, this function is equivalent to salome.sg.getActiveStudyId(). Outside GUI, it returns salome.myStudyId variable.

def studyedit.getStudyEditor (   studyId = None)

Return a StudyEditor instance to edit the study with ID studyId.

If studyId is None, return an editor for the current study.