Version: 9.12.0
SALOMEDS.idl
Go to the documentation of this file.
1 // Copyright (C) 2007-2023 CEA, EDF, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 
23 // File : SALOMEDS.idl
24 // Author : Yves FRICAUD
25 //
30 #ifndef _SALOMEDS_IDL_
31 #define _SALOMEDS_IDL_
32 
33 #include "SALOME_Exception.idl"
34 #include "SALOME_GenericObj.idl"
35 
40 module SALOMEDS
41 {
44  typedef wstring URLPath;
45 
48  typedef string ID;
49 
52  typedef string PersistentReference;
53 
56  typedef string SalomeReference;
57 
59  typedef sequence<string> ListOfFileNames;
61  typedef sequence<string> ListOfDates ;
63  typedef sequence<string> ListOfStrings ;
65  typedef sequence<ListOfStrings> ListOfListOfStrings ;
67  typedef sequence<octet> TMPFile;
68 
69  // Reference to other objects is treated with function AddReference
70  // and ReferencedObject
71  // All other type of attributes defined in AttributeType enum are
72  // treated with AddAdttribute and GetAttribute
73  // The difference is made because Reference attribute don't contain
74  // strings but reference to ID of other objects
75 
76  interface GenericAttribute;
77  interface Study;
78  interface StudyBuilder;
79  interface SObject;
80  interface SComponent;
81  interface SComponentIterator;
82  interface ChildIterator;
83  interface Driver;
84  interface AttributeStudyProperties;
85  interface AttributeParameter;
86  interface UseCaseIterator;
87  interface UseCaseBuilder;
88 
89  interface Observer
90  {
91  oneway void notifyObserverID(in string theID, in long event);
92  };
93 
94 
96  typedef sequence<GenericAttribute> ListOfAttributes;
97 
99  exception NotImplemented {};
100 
101  //==========================================================================
112  //==========================================================================
113 
114  interface StudyBuilder
115  {
120  exception LockProtection {};
129  SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
130 
135  void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
136 
141  void RemoveComponent(in SComponent aComponent) raises(LockProtection);
142 
154  SObject NewObject (in SObject theFatherObject) raises(LockProtection);
155 
164  SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
171  void RemoveObject (in SObject anObject) raises(LockProtection);
179 
186  void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
192  void Load (in SObject sco);
193 
204  in string aTypeOfAttribute) raises(LockProtection);
205 
215  boolean FindAttribute(in SObject anObject,
216  out GenericAttribute anAttribute,
217  in string aTypeOfAttribute);
226  void RemoveAttribute(in SObject anObject,
227  in string aTypeOfAttribute) raises(LockProtection);
234  void Addreference(in SObject anObject,
235  in SObject theReferencedObject) ;
236 
242  void RemoveReference(in SObject anObject) ;
243 
252  void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
259  boolean IsGUID(in SObject anObject, in string theGUID);
260 
268  void NewCommand(); // command management
278  void CommitCommand() raises(LockProtection); // command management
282  boolean HasOpenCommand();
289  void AbortCommand(); // command management
294  attribute long UndoLimit;
304  void Undo() raises (LockProtection);
314  void Redo() raises (LockProtection);
321  boolean GetAvailableUndos();
328  boolean GetAvailableRedos();
335  void SetName(in SObject theSO, in string theValue) raises (LockProtection);
336 
343  void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
344 
351  void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
352  };
353 
354  //===========================================================================
370  interface Study
371  {
372 
374  exception StudyInvalidReference {};
376  exception StudyInvalidComponent {};
378  exception StudyInvalidDirectory {};
380  exception StudyNameAlreadyUsed {};
384  exception StudyNameError {};
386  exception StudyCommentError {};
387 
391  void ping();
392  void Shutdown();
396  long getPID();
397 
401  oneway void ShutdownWithExit();
402 
407  attribute wstring Name; // equivalent to getName()
408 
413  typedef sequence<SObject> ListOfSObject;
416 
421  boolean IsEmpty() raises(StudyInvalidReference);
430  SComponent FindComponent (in string aComponentName) raises(StudyInvalidReference);
431 
434  SComponent FindComponentID(in ID aComponentID) raises(StudyInvalidReference);
442  SObject FindObject (in string anObjectName) raises(StudyInvalidReference);
448  SObject FindObjectID (in ID aObjectID) raises(StudyInvalidReference);
454  SObject CreateObjectID (in ID aObjectID) raises(StudyInvalidReference);
460  SObject FindObjectIOR (in ID aObjectIOR) raises(StudyInvalidReference);
466  ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName) raises(StudyInvalidReference);
472  SObject FindObjectByPath(in string thePath) raises(StudyInvalidReference);
475  string GetObjectPath(in Object theObject) raises(StudyInvalidReference);
476 
482  ChildIterator NewChildIterator(in SObject aSO) raises(StudyInvalidReference);
483 
488  SComponentIterator NewComponentIterator() raises(StudyInvalidReference);
489 
496  StudyBuilder NewBuilder() raises(StudyInvalidReference);
501  void UpdateIORLabelMap(in string anIOR, in string anEntry) raises(StudyInvalidReference);
502 
513  attribute boolean IsSaved;
518  boolean IsModified() raises(StudyInvalidReference);
519 
522  void Modified() raises(StudyInvalidReference);
523 
526  attribute wstring URL;
527 
532  ListOfSObject FindDependances(in SObject anObject) raises(StudyInvalidReference);
533 
538  string GetLastModificationDate() raises(StudyInvalidReference);
544  ListOfDates GetModificationsDate() raises(StudyInvalidReference);
550  string ConvertObjectToIOR(in Object theObject);
556  Object ConvertIORToObject(in string theIOR);
557 
560  UseCaseBuilder GetUseCaseBuilder() raises(StudyInvalidReference);
561 
564  void Clear() raises(StudyInvalidReference);
565 
568  void Init() raises(StudyInvalidReference);
569 
575  boolean Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception);
576 
582  boolean CanOpen (in URLPath aStudyUrl);
583 
590  boolean Save(in boolean theMultiFile, in boolean theASCII) raises(StudyInvalidReference);
591 
601  boolean SaveAs(in URLPath aUrl, // if the file already exists
602  in boolean theMultiFile, // overwrite (as option)
603  in boolean theASCII)
604  raises(StudyInvalidReference);
608  boolean CanCopy(in SObject theObject) raises(StudyInvalidReference);
613  boolean Copy(in SObject theObject) raises(StudyInvalidReference);
618  boolean CanPaste(in SObject theObject) raises(StudyInvalidReference);
625  SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
626 
629  void EnableUseCaseAutoFilling(in boolean isEnabled) raises(StudyInvalidReference);
630 
634  void AddPostponed(in string theIOR) raises(StudyInvalidReference);
635 
636  void AddCreatedPostponed(in string theIOR) raises(StudyInvalidReference);
637 
638  void RemovePostponed(in long theUndoLimit) raises(StudyInvalidReference);
639 
640  void UndoPostponed(in long theWay) raises(StudyInvalidReference);
641 
642  boolean DumpStudy(in string thePath,
643  in string theBaseName,
644  in boolean isPublished,
645  in boolean isMultiFile) raises(StudyInvalidReference);
646 
649  string GetDumpPath();
650 
656  AttributeParameter GetCommonParameters(in string theID, in long theSavePoint) raises(StudyInvalidReference);
657 
664  AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint) raises(StudyInvalidReference);
665 
666 
672  string GetDefaultScript(in string theModuleName, in string indent) raises(StudyInvalidReference);
673 
680  long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
681 
682 
688  void SetStudyLock(in string theLockerID) raises(StudyInvalidReference);
689 
694  boolean IsStudyLocked() raises(StudyInvalidReference);
695 
701  void UnLockStudy(in string theLockerID) raises(StudyInvalidReference);
702 
705  ListOfStrings GetLockerID() raises(StudyInvalidReference);
706 
713  void SetReal( in string theVarName, in double theValue ) raises(StudyInvalidReference);
714 
721  void SetInteger( in string theVarName, in long theValue ) raises(StudyInvalidReference);
728  void SetBoolean( in string theVarName, in boolean theValue ) raises(StudyInvalidReference);
729 
736  void SetString( in string theVarName, in string theValue ) raises(StudyInvalidReference);
737 
740  void SetStringAsDouble( in string theVarName, in double theValue ) raises(StudyInvalidReference);
741 
746  double GetReal( in string theVarName ) raises(StudyInvalidReference);
747 
752  long GetInteger( in string theVarName ) raises(StudyInvalidReference);
753 
758  boolean GetBoolean( in string theVarName ) raises(StudyInvalidReference);
759 
764  string GetString( in string theVarName ) raises(StudyInvalidReference);
765 
766 
772  boolean IsReal( in string theVarName ) raises(StudyInvalidReference);
773 
779  boolean IsInteger( in string theVarName ) raises(StudyInvalidReference);
780 
786  boolean IsBoolean( in string theVarName ) raises(StudyInvalidReference);
787 
793  boolean IsString( in string theVarName ) raises(StudyInvalidReference);
794 
801  boolean IsVariable( in string theVarName ) raises(StudyInvalidReference);
802 
805  ListOfStrings GetVariableNames() raises(StudyInvalidReference);
806 
814  boolean RemoveVariable( in string theVarName ) raises(StudyInvalidReference);
815 
824  boolean RenameVariable( in string theVarName, in string theNewVarName ) raises(StudyInvalidReference);
825 
833  boolean IsVariableUsed( in string theVarName ) raises(StudyInvalidReference);
834 
840  ListOfListOfStrings ParseVariables( in string theVars ) raises(StudyInvalidReference);
841 
849  void attach(in SALOMEDS::Observer theObserver, in boolean modify);
855  void detach(in SALOMEDS::Observer theObserver);
856  };
857 
858  //==========================================================================
870  //==========================================================================
871 
872  interface SObject : SALOME::GenericObj
873  {
876  attribute string Name; // equivalent to setName() & getName()
877 
880  boolean IsNull();
881 
886 
891 
896 
900  short Tag();
901 
906 
910  short Depth();
911 
916  boolean FindSubObject (in long atag, out SObject obj);
917 
924  boolean FindAttribute(out GenericAttribute anAttribute,
925  in string aTypeOfAttribute);
926 
931  boolean ReferencedObject(out SObject obj); // A REVOIR
932 
940 
945  Object GetObject();
946 
951  string GetName();
952 
957  string GetComment();
958 
963  string GetIOR();
964 
970  void SetAttrString(in string name, in string value);
971 
978  long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
979  };
980 
981 
982  //==========================================================================
987  //==========================================================================
989  {
994  exception LockProtection {};
1001  void CheckLocked() raises (LockProtection);
1002 
1004  string Type();
1005 
1007  string GetClassType();
1008 
1010  SObject GetSObject();
1011 
1013 
1018  long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1019  };
1020 
1021 
1022 
1023  //==========================================================================
1030  //==========================================================================
1031  interface SComponent : SObject
1032  {
1042  boolean ComponentIOR (out ID theID); //returns True if there is an instance
1043  //In this case ID identifies this one
1044  };
1045 
1046 
1047  //==========================================================================
1053  //==========================================================================
1055  {
1059  void Init();
1064  boolean More();
1068  void Next();
1076  };
1077 
1078  //==========================================================================
1084  //==========================================================================
1086  {
1091  void Init();
1098  void InitEx(in boolean allLevels);
1103  boolean More();
1107  void Next();
1112  };
1113 
1114  //==========================================================================
1115  //==========================================================================
1121  {
1126  void Init(in boolean allLevels);
1131  boolean More();
1135  void Next();
1140  };
1141 
1142  //==========================================================================
1143  //==========================================================================
1150  {
1157  boolean Append(in SObject theObject);
1164  boolean Remove(in SObject theObject);
1168  boolean AppendTo(in SObject theFather, in SObject theObject);
1172  long GetIndexInFather(in SObject theFather, in SObject theObject);
1176  boolean InsertBefore(in SObject theFirst, in SObject theNext);
1180  boolean SetCurrentObject(in SObject theObject);
1184  boolean SetRootCurrent();
1188  boolean HasChildren(in SObject theObject);
1192  boolean SortChildren(in SObject theObject, in boolean theAscendingOrder);
1196  SObject GetFather(in SObject theObject);
1200  boolean SetName(in string theName);
1204  string GetName();
1208  boolean IsUseCase(in SObject theObject);
1212  boolean IsUseCaseNode(in SObject theObject);
1220  SObject AddUseCase(in string theName);
1225  };
1226  //==========================================================================
1239  //==========================================================================
1240  interface Driver
1241  {
1242 
1256  TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1257 
1269  TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1270 
1280  boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1281 
1291  boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1292 
1299  void Close (in SComponent aSComponent);
1300  //void Close ( in string aIORSComponent);
1301 
1308 
1309  // Driver Transient -> persistent called for each object in study
1324  string IORToLocalPersistentID (in SObject theSObject,
1325  in string IORString,
1326  in boolean isMultiFile,
1327  in boolean isASCII);
1343  string LocalPersistentIDToIOR (in SObject theSObject,
1344  in string aLocalPersistentID,
1345  in boolean isMultiFile,
1346  in boolean isASCII)
1347  raises (SALOME::SALOME_Exception);
1348 
1349  // Publishing in the study
1355  boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1367  SObject PublishInStudy(in SObject theSObject, in Object theObject, in string theName);
1368 
1369  // copy/paste methods
1370 
1376  boolean CanCopy(in SObject theObject);
1380  TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1384  boolean CanPaste(in string theComponentName, in long theObjectID);
1388  SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);
1389 
1390  };
1391 };
1392 
1393 #endif
static std::ostream * out
Definition: DSC_interface.cxx:381
static void DumpStudy()
Function : Purpose :
Definition: SALOMEDS_Client.cxx:72
This file contains the objects defining the main exception used in SALOME application.
interface for common behavior of SALOME transient CORBA objects
Definition: SALOMEDSImpl_Attributes.hxx:34
Definition: Utils_SALOME_Exception.hxx:66
Exception locking all changes.
Definition: SALOMEDS.idl:994
Exception indicating that this feature hasn't been implemented in SALOME application.
Definition: SALOMEDS.idl:99
LockProtection Exception
Definition: SALOMEDS.idl:120
Invalid study comment.
Definition: SALOMEDS.idl:386
Invalid study component.
Definition: SALOMEDS.idl:376
Invalid directory of the study exception.
Definition: SALOMEDS.idl:378
Invalid study reference.
Definition: SALOMEDS.idl:374
Exception pointing that this name of the study has already been used.
Definition: SALOMEDS.idl:380
Invalid name of the study exception.
Definition: SALOMEDS.idl:384
study object already exists
Definition: SALOMEDS.idl:382
The main exception in SALOME application.
Definition: SALOME_Exception.idl:71
Parameter attribute.
Definition: SALOMEDS_Attributes.idl:1717
Study properties attribute
Definition: SALOMEDS_Attributes.idl:1535
ChildIterator interface
Definition: SALOMEDS.idl:1086
void Init()
Activates the ChildIterator.
void InitEx(in boolean allLevels)
Activates the ChildIterator for all child levels.
void Next()
Passes the iterator to the next level.
SObject Value()
Returns the SObject corresponding to the current object found by the iterator.
boolean More()
Method More.
Driver interface
Definition: SALOMEDS.idl:1241
string IORToLocalPersistentID(in SObject theSObject, in string IORString, in boolean isMultiFile, in boolean isASCII)
Transforms IOR of a given SObject into PersistentID.
boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile)
Loading the data.
void Close(in SComponent aSComponent)
Closing of the study.
string LocalPersistentIDToIOR(in SObject theSObject, in string aLocalPersistentID, in boolean isMultiFile, in boolean isASCII)
Transforms PersistentID into IOR of the object.
TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile)
Saving the data in ASCII format produced by a definite component.
TMPFile CopyFrom(in SObject theObject, out long theObjectID)
Returns the object ID and the TMPFile of the object from the given SObject.
boolean CanPublishInStudy(in Object theIOR)
Publishing in the study.
boolean CanPaste(in string theComponentName, in long theObjectID)
Returns True, if the component can paste the object with given ID of the component with name theCompo...
TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile)
Saving the data produced by a definite component.
boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile)
Loading the data from files in ASCII format.
SObject PublishInStudy(in SObject theSObject, in Object theObject, in string theName)
Publishing in the study.
string ComponentDataType()
Gets the type of the data.
boolean CanCopy(in SObject theObject)
Returns True, if the given SObject can be copied to the clipboard.
SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject)
Returns the SObject of the pasted object.
Generic attribute interface
Definition: SALOMEDS.idl:989
void CheckLocked()
Method CheckLocked.
Definition: SALOMEDS.idl:90
oneway void notifyObserverID(in string theID, in long event)
SComponentIterator interface
Definition: SALOMEDS.idl:1055
void Next()
Moves the iterator to the next SComponent in the list.
boolean More()
Method More.
void Init()
Activates the SComponentIterator.
SComponent interface
Definition: SALOMEDS.idl:1032
string ComponentDataType()
Gets the data type of the given SComponent.
boolean ComponentIOR(out ID theID)
Gets the IOR of the given component.
SObject interface
Definition: SALOMEDS.idl:873
SObject GetFather()
Acquisition of the father SObject of the SObject.
Object GetObject()
Gets the CORBA object by its own IOR attribute.
string GetName()
Returns the name attribute value of this SObject.
boolean FindSubObject(in long atag, out SObject obj)
Looks for subobjects of a given SObject.
boolean FindAttribute(out GenericAttribute anAttribute, in string aTypeOfAttribute)
Looks for attributes of a given SObject.
ID GetID()
Gets an object ID.
string GetComment()
Returns the comment attribute value of this SObject.
attribute string Name
Name of the SObject.
Definition: SALOMEDS.idl:876
short Tag()
Gets the tag of a SObject.
SComponent GetFatherComponent()
Acquisition of the father Component of the SObject.
short Depth()
Gets the depth of a SObject.
string GetIOR()
Returns the IOR attribute value of this SObject.
boolean IsNull()
Returns true if the SObject does not belong to any Study.
long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal)
Private method, returns an implementation of this SObject.
ListOfAttributes GetAllAttributes()
Gets all attributes of a given SObject.
boolean ReferencedObject(out SObject obj)
Looks for a SObject which the given SObject refers to.
short GetLastChildTag()
Returns a tag of the last child SObject (if any) of this SObject.
void SetAttrString(in string name, in string value)
Set an attribute value (of type string)
Study Builder Interface
Definition: SALOMEDS.idl:115
void NewCommand()
Creation of a new command.
void RemoveComponent(in SComponent aComponent)
Deletion of a SComponent.
void RemoveReference(in SObject anObject)
Removes a reference from anObject to another object.
GenericAttribute FindOrCreateAttribute(in SObject anObject, in string aTypeOfAttribute)
Looking for or creating an attribute assigned to the SObject.
void CommitCommand()
Execution of the command.
void DefineComponentInstance(in SComponent aComponent, in Object ComponentIOR)
Definition of the instance to the SComponent.
void RemoveObjectWithChildren(in SObject anObject)
Deletion of the SObject with all his child objects.
SObject NewObject(in SObject theFatherObject)
Creation of a new SObject.
void RemoveAttribute(in SObject anObject, in string aTypeOfAttribute)
Deleting the attribute assigned to the SObject.
SComponent NewComponent(in string ComponentDataType)
Creation of a new SComponent.
void LoadWith(in SComponent sco, in Driver Engine)
Loads a SComponent.
void RemoveObject(in SObject anObject)
Deletion of the SObject.
boolean IsGUID(in SObject anObject, in string theGUID)
Searches for a definite SObject with a definite GUID and returns True if it finds it.
SObject NewObjectToTag(in SObject theFatherObject, in long atag)
Creation of a new SObject with a definite tag.
void Load(in SObject sco)
Loads a SObject.
void Addreference(in SObject anObject, in SObject theReferencedObject)
Adds a reference between anObject and theReferencedObject.
void SetGUID(in SObject anObject, in string theGUID)
Identification of the SObject's substructure.
boolean FindAttribute(in SObject anObject, out GenericAttribute anAttribute, in string aTypeOfAttribute)
Looking for an attribute assigned to a SObject.
Study Interface
Definition: SALOMEDS.idl:371
oneway void ShutdownWithExit()
Shutdown the Study process.
long getPID()
Returns the PID of the server.
sequence< SObject > ListOfSObject
Indicate the file where the study has been saved.
Definition: SALOMEDS.idl:413
PersistentReference GetPersistentReference()
Get the persistent reference to the Study.
void ping()
Determines whether the server has already been loaded or not.
attribute wstring Name
The name of the Study.
Definition: SALOMEDS.idl:407
Interface of the UseCaseBuilder.
Definition: SALOMEDS.idl:1150
boolean IsUseCaseNode(in SObject theObject)
Returns True if the given object theObject is included in the use cases tree on any level.
string GetName()
Gets the name of the use case.
boolean InsertBefore(in SObject theFirst, in SObject theNext)
Inserts in the use case the object theFirst before the object theNext.
boolean Append(in SObject theObject)
Adds to the use case an object as a child of the current object of the use case.
boolean IsUseCase(in SObject theObject)
Returns True if the given object theObject represents a use case.
UseCaseIterator GetUseCaseIterator(in SObject theObject)
Returns the UseCaseIterator for the given object theObject in the use case.
SObject GetFather(in SObject theObject)
Gets father object of the given object theObject in the use cases tree.
boolean Remove(in SObject theObject)
Removes an object from the use case.
boolean SetRootCurrent()
Makes the root object to be the current object of the use case.
boolean SortChildren(in SObject theObject, in boolean theAscendingOrder)
Returns True if children of the given object theObject of the use case tree were sorted successfully.
long GetIndexInFather(in SObject theFather, in SObject theObject)
Return index of a child among father children.
boolean SetName(in string theName)
Sets the name of the use case.
boolean AppendTo(in SObject theFather, in SObject theObject)
Adds a child object theObject to the given father theFather object in the use case.
SObject GetCurrentObject()
Gets the current object of the use case.
SObject AddUseCase(in string theName)
Creates a new use case in the use case browser.
boolean SetCurrentObject(in SObject theObject)
Sets the current object of the use case.
boolean HasChildren(in SObject theObject)
Returns True if the given object theObject of the use case has child objects.
Interface of the UseCaseIterator.
Definition: SALOMEDS.idl:1121
SObject Value()
Returns the SObject corresponding to the current object found by the Iterator.
void Next()
Passes the iterator to the next object.
void Init(in boolean allLevels)
Activates the UseCaseIterator.
boolean More()
Method More.
interface for common behavior of SALOME transient CORBA objects
Definition: SALOME_GenericObj.idl:40
obj
Definition: batchmode_salome.py:275
def SetName(objId, name)
Definition: salome_ComponentGUI.py:89
def Init()
Definition: salome_ComponentGUI.py:84
This package contains the interfaces used for creation, management and modification of the Study.
Definition: SALOMEDS.hxx:37
sequence< string > ListOfFileNames
List of file names.
Definition: SALOMEDS.idl:59
sequence< string > ListOfDates
List of modification dates of a study.
Definition: SALOMEDS.idl:61
sequence< octet > TMPFile
A byte stream which is used for binary data transfer between different components.
Definition: SALOMEDS.idl:67
sequence< ListOfStrings > ListOfListOfStrings
An unbounded sequence of sequence of strings.
Definition: SALOMEDS.idl:65
wstring URLPath
Name of the file in which the Study is saved.
Definition: SALOMEDS.idl:44
string SalomeReference
IOR of the study in SALOME application.
Definition: SALOMEDS.idl:56
string ID
Main identifier of an object in SALOME application.
Definition: SALOMEDS.idl:48
string PersistentReference
While saving the data, IOR is transformed into persistent reference.
Definition: SALOMEDS.idl:52
sequence< string > ListOfStrings
An unbounded sequence of strings.
Definition: SALOMEDS.idl:63
sequence< GenericAttribute > ListOfAttributes
List of attributes of SObjects.
Definition: SALOMEDS.idl:92
Module SALOME contains all base interfaces of SALOME Kernel.
Definition: HeatMarcel.hxx:25
string name
Definition: pythfilter.py:56