KERNEL_PY.salome_study Namespace Reference

Functions
def	DumpComponent (SO, Builder, offset)
def	DumpStudy ()
def	IDToObject (id)
def	ObjectToSObject (obj)
def	ObjectToID (obj)
def	IDToSObject (id)
def	generateName (prefix=None)
def	PersistentPresentation (theSO, theWithID)
def	GetTree (theSO)
def	CheckCopyPaste (theSO, theInfo, theComponentPaste)
def	GetComponentVersion (theComponent, all_versions=False)
def	FindFileInDataDir (filename)
def	openStudy (theStudyPath)
def	salome_study_init_without_session (theStudyPath=None)
def	salome_study_init (theStudyPath=None)
def	salome_study_close ()

Variables
	myStudy = None
	myStudyName = None

Function Documentation

CheckCopyPaste()

def KERNEL_PY.salome_study.CheckCopyPaste	(		theSO,
			theInfo,
			theComponentPaste
	)

References KERNEL_PY.salome_study.GetTree(), and KERNEL_PY.salome_study.PersistentPresentation().

DumpComponent()

def KERNEL_PY.salome_study.DumpComponent	(		SO,
			Builder,
			offset
	)

Referenced by KERNEL_PY.salome_study.DumpStudy().

DumpStudy()

def KERNEL_PY.salome_study.DumpStudy

(

)

Dump a study, given the ior

References KERNEL_PY.salome_study.DumpComponent().

FindFileInDataDir()

def KERNEL_PY.salome_study.FindFileInDataDir

(

filename

)

generateName()

def KERNEL_PY.salome_study.generateName

(

prefix = None

)

GetComponentVersion()

def KERNEL_PY.salome_study.GetComponentVersion	(		theComponent,
			all_versions = False
	)

GetTree()

def KERNEL_PY.salome_study.GetTree

(

theSO

)

Referenced by KERNEL_PY.salome_study.CheckCopyPaste().

IDToObject()

def KERNEL_PY.salome_study.IDToObject

(

id

)

IDToSObject()

def KERNEL_PY.salome_study.IDToSObject

(

id

)

ObjectToID()

def KERNEL_PY.salome_study.ObjectToID

(

obj

)

References KERNEL_PY.salome_study.ObjectToSObject().

ObjectToSObject()

def KERNEL_PY.salome_study.ObjectToSObject

(

obj

)

Referenced by KERNEL_PY.salome_study.ObjectToID().

openStudy()

def KERNEL_PY.salome_study.openStudy

(

theStudyPath

)

Referenced by KERNEL_PY.salome_study.salome_study_init(), and KERNEL_PY.salome_study.salome_study_init_without_session().

PersistentPresentation()

def KERNEL_PY.salome_study.PersistentPresentation	(		theSO,
			theWithID
	)

Referenced by KERNEL_PY.salome_study.CheckCopyPaste().

salome_study_close()

def KERNEL_PY.salome_study.salome_study_close

(

)

Referenced by salome.salome_close(), and KERNEL_PY.salome_close().

salome_study_init()

def KERNEL_PY.salome_study.salome_study_init

(

theStudyPath = None

)

Performs only once study creation or connection.
optional argument : theStudyPath
    None        : attach to the currently active single study;
                  create new empty study if there is active study
    <URL> (str) : open study with the given file name

References KERNEL_PY.salome_study.openStudy().

Referenced by salome.salome_init_with_session(), and KERNEL_PY.salome_init_with_session().

salome_study_init_without_session()

def KERNEL_PY.salome_study.salome_study_init_without_session

(

theStudyPath = None

)

Performs only once study creation or connection.
optional argument : theStudyPath
    None        : attach to the currently active single study;
                  create new empty study if there is active study
    <URL> (str) : open study with the given file name

References KERNEL_PY.salome_study.openStudy().

Referenced by salome.salome_init_without_session_common(), and KERNEL_PY.salome_init_without_session_common().

Variable Documentation

myStudy

KERNEL_PY.salome_study.myStudy = None

myStudyName

KERNEL_PY.salome_study.myStudyName = None