interface Study
IDL file
Python
PersistentReference GetPersistentReference ( )
return_value = GetPersistentReference ( )
SalomeReference GetTransientReference ( )
return_value = GetTransientReference ( )
boolean IsEmpty ( )
return_value = IsEmpty ( )
SComponent FindComponent ( in string aComponentName )
return_value = FindComponent ( aComponentName )
SComponent FindComponentID ( in ID aComponentID )
return_value = FindComponentID ( aComponentID )
SObject FindObject ( in string anObjectName )
return_value = FindObject ( anObjectName )
SObject FindObjectID ( in ID aObjectID )
return_value = FindObjectID ( aObjectID )
SObject FindObjectIOR ( in ID aObjectIOR )
return_value = FindObjectIOR ( aObjectIOR )
ListOfSObject FindObjectByName ( in string anObjectName, in string aComponentName )
return_value = FindObjectByName ( anObjectName, aComponentName )
SObject FindObjectByPath ( in string thePath )
return_value = FindObjectByPath ( thePath )
string GetObjectPath ( in Object theObject )
return_value = GetObjectPath ( theObject )
void SetContext ( in string thePath )
SetContext ( thePath )
string GetContext ( )
return_value = GetContext ( )
ListOfStrings GetObjectNames ( in string theContext )
return_value = GetObjectNames ( theContext )
ListOfStrings GetDirectoryNames ( in string theContext )
return_value = GetDirectoryNames ( theContext )
ListOfStrings GetFileNames ( in string theContext )
return_value = GetFileNames ( theContext )
ListOfStrings GetComponentNames ( in string theContext )
return_value = GetComponentNames ( theContext )
ChildIterator NewChildIterator ( in SObject aSO )
return_value = NewChildIterator ( aSO )
SComponentIterator NewComponentIterator ( )
return_value = NewComponentIterator ( )
StudyBuilder NewBuilder ( )
return_value = NewBuilder ( )
void UpdateIORLabelMap ( in string anIOR, in string anEntry )
UpdateIORLabelMap ( anIOR, anEntry )
AttributeStudyProperties GetProperties ( )
return_value = GetProperties ( )
boolean IsModified ( )
return_value = IsModified ( )
ListOfSObject FindDependances ( in SObject anObject )
return_value = FindDependances ( anObject )
string GetLastModificationDate ( )
return_value = GetLastModificationDate ( )
ListOfDates GetModificationsDate ( )
return_value = GetModificationsDate ( )
string ConvertObjectToIOR ( in Object theObject )
return_value = ConvertObjectToIOR ( theObject )
Object ConvertIORToObject ( in string theIOR )
return_value = ConvertIORToObject ( theIOR )
UseCaseBuilder GetUseCaseBuilder ( )
return_value = GetUseCaseBuilder ( )
void Close ( )
Close ( )
void EnableUseCaseAutoFilling ( in boolean isEnabled )
EnableUseCaseAutoFilling ( isEnabled )

interface StudyBuilder
IDL file
Python
SComponent NewComponent ( in string ComponentDataType )
return_value = NewComponent ( ComponentDataType )
void DefineComponentInstance ( in SComponent aComponent, in Object ComponentIOR )
DefineComponentInstance ( aComponent, ComponentIOR )
void RemoveComponent ( in SComponent aComponent )
RemoveComponent ( aComponent )
SObject NewObject ( in SObject theFatherObject )
return_value = NewObject ( theFatherObject )
SObject NewObjectToTag ( in SObject theFatherObject, in long atag )
return_value = NewObjectToTag ( theFatherObject, atag )
void RemoveObject ( in SObject anObject )
RemoveObject ( anObject )
void RemoveObjectWithChildren ( in SObject anObject )
RemoveObjectWithChildren ( anObject )
void LoadWith ( in SComponent sco, in Driver Engine )
LoadWith ( sco, Engine )
void Load ( in SObject sco )
Load ( sco )
GenericAttribute FindOrCreateAttribute ( in SObject anObject, in string aTypeOfAttribute )
return_value = FindOrCreateAttribute ( anObject, aTypeOfAttribute )
boolean FindAttribute ( in SObject anObject, out GenericAttribute anAttribute, in string aTypeOfAttribute )
[ return_value, anAttribute ] = FindAttribute ( anObject, aTypeOfAttribute )
void RemoveAttribute ( in SObject anObject, in string aTypeOfAttribute )
RemoveAttribute ( anObject, aTypeOfAttribute )
void Addreference ( in SObject anObject, in SObject theReferencedObject )
Addreference ( anObject, theReferencedObject )
void AddDirectory ( in string theName )
AddDirectory ( theName )
void SetGUID ( in SObject anObject, in string theGUID )
SetGUID ( anObject, theGUID )
boolean IsGUID ( in SObject anObject, in string theGUID )
return_value = IsGUID ( anObject, theGUID )
void NewCommand ( )
NewCommand ( )
void CommitCommand ( )
CommitCommand ( )
boolean HasOpenCommand ( )
return_value = HasOpenCommand ( )
void AbortCommand ( )
AbortCommand ( )
void Undo ( )
Undo ( )
void Redo ( )
Redo ( )
boolean GetAvailableUndos ( )
return_value = GetAvailableUndos ( )
boolean GetAvailableRedos ( )
return_value = GetAvailableRedos ( )
Callback SetOnAddSObject ( in Callback theCallback )
return_value = SetOnAddSObject ( theCallback )
Callback SetOnRemoveSObject ( in Callback theCallback )
return_value = SetOnRemoveSObject ( theCallback )

interface StudyManager
IDL file
Python
void ping ( )
ping ( )
Study NewStudy ( in string study_name )
return_value = NewStudy ( study_name )
Study Open ( in URL aStudyUrl )
return_value = Open ( aStudyUrl )
void Close ( in Study aStudy )
Close ( aStudy )
void Save ( in Study aStudy, in boolean theMultiFile )
Save ( aStudy, theMultiFile )
void SaveASCII ( in Study aStudy, in boolean theMultiFile )
SaveASCII ( aStudy, theMultiFile )
void SaveAs ( in URL aUrl, in Study aStudy, in boolean theMultiFile )
SaveAs ( aUrl, aStudy, theMultiFile )
void SaveAsASCII ( in URL aUrl, in Study aStudy, in boolean theMultiFile )
SaveAsASCII ( aUrl, aStudy, theMultiFile )
ListOfOpenStudies GetOpenStudies ( )
return_value = GetOpenStudies ( )
Study GetStudyByName ( in string aStudyName )
return_value = GetStudyByName ( aStudyName )
Study GetStudyByID ( in short aStudyID )
return_value = GetStudyByID ( aStudyID )
boolean CanCopy ( in SObject theObject )
return_value = CanCopy ( theObject )
boolean Copy ( in SObject theObject )
return_value = Copy ( theObject )
boolean CanPaste ( in SObject theObject )
return_value = CanPaste ( theObject )
SObject Paste ( in SObject theObject )
return_value = Paste ( theObject )

interface SObject
IDL file
Python
ID GetID ( )
return_value = GetID ( )
SComponent GetFatherComponent ( )
return_value = GetFatherComponent ( )
SObject GetFather ( )
return_value = GetFather ( )
short Tag ( )
return_value = Tag ( )
boolean FindSubObject ( in long atag, out SObject obj )
[ return_value, obj ] = FindSubObject ( atag )
boolean FindAttribute ( out GenericAttribute anAttribute, in string aTypeOfAttribute )
[ return_value, anAttribute ] = FindAttribute ( aTypeOfAttribute )
boolean ReferencedObject ( out SObject obj )
[ return_value, obj ] = ReferencedObject ( )
ListOfAttributes GetAllAttributes ( )
return_value = GetAllAttributes ( )
Study GetStudy ( )
return_value = GetStudy ( )

interface GenericAttribute
IDL file
Python
void CheckLocked ( )
CheckLocked ( )

interface SComponent
IDL file
Python
string ComponentDataType ( )
return_value = ComponentDataType ( )
boolean ComponentIOR ( out ID theID )
[ return_value, theID ] = ComponentIOR ( )

interface SComponentIterator
IDL file
Python
void Init ( )
Init ( )
boolean More ( )
return_value = More ( )
void Next ( )
Next ( )
SComponent Value ( )
return_value = Value ( )

interface ChildIterator
IDL file
Python
void Init ( )
Init ( )
void InitEx ( in boolean allLevels )
InitEx ( allLevels )
boolean More ( )
return_value = More ( )
void Next ( )
Next ( )
SObject Value ( )
return_value = Value ( )

interface UseCaseIterator
IDL file
Python
void Init ( in boolean allLevels )
Init ( allLevels )
boolean More ( )
return_value = More ( )
void Next ( )
Next ( )
SObject Value ( )
return_value = Value ( )

interface UseCaseBuilder
IDL file
Python
boolean Append ( in SObject theObject )
return_value = Append ( theObject )
boolean Remove ( in SObject theObject )
return_value = Remove ( theObject )
boolean AppendTo ( in SObject theFather, in SObject theObject )
return_value = AppendTo ( theFather, theObject )
boolean InsertBefore ( in SObject theFirst, in SObject theNext )
return_value = InsertBefore ( theFirst, theNext )
boolean SetCurrentObject ( in SObject theObject )
return_value = SetCurrentObject ( theObject )
boolean SetRootCurrent ( )
return_value = SetRootCurrent ( )
boolean HasChildren ( in SObject theObject )
return_value = HasChildren ( theObject )
boolean SetName ( in string theName )
return_value = SetName ( theName )
string GetName ( )
return_value = GetName ( )
boolean IsUseCase ( in SObject theObject )
return_value = IsUseCase ( theObject )
SObject GetCurrentObject ( )
return_value = GetCurrentObject ( )
SObject AddUseCase ( in string theName )
return_value = AddUseCase ( theName )
UseCaseIterator GetUseCaseIterator ( in SObject theObject )
return_value = GetUseCaseIterator ( theObject )

interface Callback
IDL file
Python
void OnAddSObject ( in SObject theObject )
OnAddSObject ( theObject )
void OnRemoveSObject ( in SObject theObject )
OnRemoveSObject ( theObject )

interface Driver
IDL file
Python
TMPFile Save ( in SComponent theComponent, in string theURL, in boolean isMultiFile )
return_value = Save ( theComponent, theURL, isMultiFile )
TMPFile SaveASCII ( in SComponent theComponent, in string theURL, in boolean isMultiFile )
return_value = SaveASCII ( theComponent, theURL, isMultiFile )
boolean Load ( in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile )
return_value = Load ( theComponent, theStream, theURL, isMultiFile )
boolean LoadASCII ( in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile )
return_value = LoadASCII ( theComponent, theStream, theURL, isMultiFile )
void Close ( in SComponent aSComponent )
Close ( aSComponent )
string ComponentDataType ( )
return_value = ComponentDataType ( )
string IORToLocalPersistentID ( in SObject theSObject, in string IORString, in boolean isMultiFile, in boolean isASCII )
return_value = IORToLocalPersistentID ( theSObject, IORString, isMultiFile, isASCII )
string LocalPersistentIDToIOR ( in SObject theSObject, in string aLocalPersistentID, in boolean isMultiFile, in boolean isASCII )
return_value = LocalPersistentIDToIOR ( theSObject, aLocalPersistentID, isMultiFile, isASCII )
boolean CanPublishInStudy ( in Object theIOR )
return_value = CanPublishInStudy ( theIOR )
SObject PublishInStudy ( in Study theStudy, in SObject theSObject, in Object theObject, in string theName )
return_value = PublishInStudy ( theStudy, theSObject, theObject, theName )
boolean CanCopy ( in SObject theObject )
return_value = CanCopy ( theObject )
TMPFile CopyFrom ( in SObject theObject, out long theObjectID )
[ return_value, theObjectID ] = CopyFrom ( theObject )
boolean CanPaste ( in string theComponentName, in long theObjectID )
return_value = CanPaste ( theComponentName, theObjectID )
SObject PasteInto ( in TMPFile theStream, in long theObjectID, in SObject theObject )
return_value = PasteInto ( theStream, theObjectID, theObject )