1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SALOMEDS.idl
24 // Author : Yves FRICAUD
26 /*! \file SALOMEDS.idl \brief This file contains a set of interfaces used for creation, management
27 and modification of the %Study
30 #ifndef _SALOMEDS_IDL_
31 #define _SALOMEDS_IDL_
33 #include "SALOME_Exception.idl"
34 #include "SALOME_GenericObj.idl"
37 This package contains the interfaces used for creation, management
38 and modification of the %Study
42 /*! \brief Name of the file in which the %Study is saved.
46 /*! \brief Main identifier of an object in %SALOME application
50 /*! \brief While saving the data, IOR is transformed into persistent reference
52 typedef string PersistentReference;
54 /*! \brief IOR of the study in %SALOME application
56 typedef string SalomeReference;
58 /*! \brief List of the names of studies which are currently open in this %SALOME session.
60 Since %SALOME is a multi-study application, it allows to open a lot of studies
61 during each working session.
63 typedef sequence<string> ListOfOpenStudies;
64 //! List of file names
65 typedef sequence<string> ListOfFileNames;
66 //! List of modification dates of a study
67 typedef sequence<string> ListOfDates ;
68 //! An unbounded sequence of strings
69 typedef sequence<string> ListOfStrings ;
70 //! An unbounded sequence of sequence of strings
71 typedef sequence<ListOfStrings> ListOfListOfStrings ;
72 //! A byte stream which is used for binary data transfer between different components
73 typedef sequence<octet> TMPFile;
75 // Reference to other objects is treated with function AddReference
76 // and ReferencedObject
77 // All other type of attributes defined in AttributeType enum are
78 // treated with AddAdttribute and GetAttribute
79 // The difference is made because Reference attribute don't contain
80 // strings but reference to ID of other objects
82 interface GenericAttribute;
84 interface StudyManager;
85 interface StudyBuilder;
88 interface SComponentIterator;
89 interface ChildIterator;
91 interface AttributeStudyProperties;
92 interface AttributeParameter;
93 interface UseCaseIterator;
94 interface UseCaseBuilder;
98 void notifyObserverID(in string theID, in long event);
102 //! List of attributes of %SObjects
103 typedef sequence<GenericAttribute> ListOfAttributes;
105 //! Exception indicating that this feature hasn't been implemented in %SALOME application.
106 exception NotImplemented {};
109 //===========================================================================
110 /*! \brief %Study Interface
112 The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
113 Most of the %Study operations are handled by the StudyManager and the StudyBuilder.
114 What is left in the %Study interface are elementary inquiries.
115 (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
116 and set methods.) A %Study is explored by a set of tools, mainly iterators
117 , which are described further. Nevertheless, the %Study
118 interface allows the search of an object by name or by ID.
120 <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
121 In general it's a string of names of directories divided by a slash '/'.
122 <BR><VAR>The Context</VAR> is the current directory of an object.</P>
128 //! Invalid study context
129 exception StudyInvalidContext {};
130 //! Invalid study component
131 exception StudyInvalidComponent {};
132 //! Invalid directory of the %study exception
133 exception StudyInvalidDirectory {};
134 //! Exception pointing that this name of the study has already been used.
135 exception StudyNameAlreadyUsed {};
136 //! study object already exists
137 exception StudyObjectAlreadyExists {};
138 //! Invalid name of the %study exception
139 exception StudyNameError {};
140 //! Invalid study comment
141 exception StudyCommentError {};
143 /*! \brief The name of the %Study
145 This is equivalent to the methods setName() & getName()
147 attribute string Name; // equivalent to setName() & getName()
148 /*! \brief The ID of the %Study
150 This is equivalent to the methods setID() & getID()
152 attribute short StudyId;
153 //! Sequence containing %SObjects
154 typedef sequence<SObject> ListOfSObject;
155 //! Get the persistent reference to the %Study.
156 PersistentReference GetPersistentReference();
157 //! Get a transient reference to the %Study.
158 SalomeReference GetTransientReference();
160 /*! \brief indicate whether the %Study is empty
162 \return True if the %Study is empty
165 /*! \brief Find a %SComponent by its name.
167 \param aComponentName It's a string value in the Comment Attribute of the Component,
168 which is looked for, defining the data type of this Component.
170 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
173 SComponent FindComponent (in string aComponentName);
175 /*! \brief Find a %SComponent by ID of the according %SObject
177 SComponent FindComponentID(in ID aComponentID);
178 /*! \brief Find a %SObject by the Name Attribute of this %SObject
180 \param anObjectName String parameter defining the name of the object
181 \return The obtained %SObject
183 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
185 SObject FindObject (in string anObjectName);
186 /*! \brief Find a %SObject by its ID
188 \param aObjectID This parameter defines the ID of the required object
189 \return The obtained %SObject
191 SObject FindObjectID (in ID aObjectID);
192 /*! \brief Create a %SObject by its ID
194 \param aObjectID This parameter defines the ID of the required object
195 \return The created %SObject
197 SObject CreateObjectID (in ID aObjectID);
198 /*! \brief Find a %SObject by IOR of the object belonging to this %SObject.
200 \param anObjectName This parameter defines the IOR of the object
201 \return The obtained %SObject
203 SObject FindObjectIOR (in ID aObjectIOR);
204 /*! \brief Find in the study all %SObjects produced by a given %Component.
206 \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
207 \param aComponentName The name of the component, which objects are searched for.
209 ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
210 /*! \brief Find a %SObject by the path to it.
212 \param thePath The path to the required %SObject.
213 \return The obtained %SObject.
215 SObject FindObjectByPath(in string thePath);
216 /*! \brief Get the path to the %SObject.
218 string GetObjectPath(in Object theObject);
220 /*! \brief Set the context of the %Study.
222 \param thePath String parameter defining the context of the study.
224 <em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
226 void SetContext(in string thePath);
227 /*! \brief Get the context of the %Study.
229 <em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
232 /*! \brief Get a list of names of objects corresponding to the context.
234 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
236 ListOfStrings GetObjectNames(in string theContext);
237 /*! \brief Get a list of names of directories and subdirectories corresponding to the context.
239 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
241 ListOfStrings GetDirectoryNames(in string theContext);
242 /*! \brief Get a list of names of Files corresponding to the context.
244 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
246 ListOfStrings GetFileNames(in string theContext);
247 /*! \brief Get a list of names of Components corresponding to the context.
249 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
251 ListOfStrings GetComponentNames(in string theContext);
252 /*! \brief Create a new iterator of child levels of the given %SObject.
254 \param aSO The given %SObject
255 \return A new iterator of child levels of the given %SObject.
257 ChildIterator NewChildIterator(in SObject aSO);
259 /*! \brief Create a new iterator of the %SComponents.
261 \return A new iterator of the %SComponents.
263 SComponentIterator NewComponentIterator();
265 /*! \brief Create a new %StudyBuilder to add or modify an object in the study.
267 \return A new %StudyBuilder.
269 <em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
271 StudyBuilder NewBuilder() ;
272 /*! \brief Labels dependency
274 Updates the map with IOR attribute. It's an inner method used for optimization.
276 void UpdateIORLabelMap(in string anIOR, in string anEntry);
278 /*! \brief Getting properties of the study
280 Returns the attribute, which contains the properties of this study.
282 <em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
285 AttributeStudyProperties GetProperties();
286 /*! \brief Indicate whether the %study has been saved
288 attribute boolean IsSaved;
289 /*! \brief Indicate whether the %study has been modified and not saved.
291 Returns True if the %study has been modified and not saved.
293 boolean IsModified();
295 /*! \brief Mark the %study as being modified and not saved.
299 /*! \brief Indicate the file where the %study has been saved
301 attribute string URL;
303 /*! \brief List of %SObjects
305 Returns the list of %SObjects which refers to %anObject.
307 ListOfSObject FindDependances(in SObject anObject);
309 /*! \brief The date of the last saving of the study
311 Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
313 string GetLastModificationDate();
314 /*! \brief The list of modification dates of the study
316 Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
317 Note : the first modification begins the list.
319 ListOfDates GetModificationsDate();
320 /*! \brief Object conversion.
322 Converts an object into IOR.
325 string ConvertObjectToIOR(in Object theObject);
326 /*! \brief Object conversion.
328 Converts IOR into an object.
331 Object ConvertIORToObject(in string theIOR);
332 /*! \brief Get a new %UseCaseBuilder.
334 UseCaseBuilder GetUseCaseBuilder();
336 /*! \brief Close the components in the study, remove itself from the %StudyManager.
340 /*! \brief Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case.
342 void EnableUseCaseAutoFilling(in boolean isEnabled);
345 Functions for internal usage only
347 void AddPostponed(in string theIOR);
349 void AddCreatedPostponed(in string theIOR);
351 void RemovePostponed(in long theUndoLimit);
353 void UndoPostponed(in long theWay);
355 boolean DumpStudy(in string thePath, in string theBaseName, in boolean isPublished);
357 /*! \brief Get an AttributeParameter used to store common parameters for given %theSavePoint.
359 \param theID identifies a common parameters set (Example: "Interface Applicative")
360 \param theSavePoint is number of a set of parameters as there can be several sets
362 AttributeParameter GetCommonParameters(in string theID, in long theSavePoint);
364 /*! \brief Get an AttributeParameter used to store parameters for given %theModuleName.
366 \param theID identifies a common parameters set (Example: "Interface Applicative")
367 \param theModuleName is a name of the module (Example: "Geometry")
368 \param theSavePoint is number of a set of parameters as there can be several sets
370 AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint);
373 /*! \brief Get a default Python script to restore visual parameters for given %theModuleName.
375 \param theID identifies a common parameters set (Example: "Interface Applicative")
376 \param theModuleName is a name of the module (Example: "Geometry")
378 string GetDefaultScript(in string theID, in string theModuleName);
381 Private method, returns an implementation of this Study.
382 \param theHostname is a hostname of the caller
383 \param thePID is a process ID of the caller
384 \param isLocal is set True if the Study is launched locally with the caller
386 long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
389 /*! \brief Mark this Study as being locked by the given locker.
391 The lock status can be checked by method IsStudyLocked
392 \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that locks the study.
394 void SetStudyLock(in string theLockerID);
396 /*! \brief Indicate if the Study is locked
398 Returns True if the Study was marked locked.
400 boolean IsStudyLocked();
402 /*! \brief Mark this Study as being unlocked by the given locker.
404 The lock status can be checked by method IsStudyLocked
405 \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that unlocks the study.
407 void UnLockStudy(in string theLockerID);
409 /*! \brief Get the list of IDs of the Study's lockers.
411 ListOfStrings GetLockerID();
413 /*! \brief Create real variable with Name theVarName and value theValue
415 (or set if variable value into theValue already exists)
416 \param theVarName is a name of the variable
417 \param theVarName is a value of the variable.
419 void SetReal( in string theVarName, in double theValue );
421 /*! \brief Create integer variable with Name theVarName and value theValue
423 (or set if variable value into theValue already exists)
424 \param theVarName is a name of the variable
425 \param theVarName is a value of the variable.
427 void SetInteger( in string theVarName, in long theValue );
428 /*! \brief Create boolean variable with Name theVarName and value theValue
430 (or set if variable value into theValue already exists)
431 \param theVarName is a name of the variable
432 \param theVarName is a value of the variable.
434 void SetBoolean( in string theVarName, in boolean theValue );
436 /*! \brief Create string variable with Name theVarName and value theValue
438 (or set if variable value into theValue already exists)
439 \param theVarName is a name of the variable
440 \param theVarName is a value of the variable.
442 void SetString( in string theVarName, in string theValue );
444 /*! \brief Set current value as double for string variable
446 void SetStringAsDouble( in string theVarName, in double theValue );
448 /*! \brief Get value of a real variable
450 \param theVarName is a name of the variable.
452 double GetReal( in string theVarName );
454 /*! \brief Get value of an integer variable
456 \param theVarName is a name of the variable.
458 long GetInteger( in string theVarName );
460 /*! \brief Get value of a boolean variable
462 \param theVarName is a name of the variable.
464 boolean GetBoolean( in string theVarName );
466 /*! \brief Get value of a string variable
468 \param theVarName is a name of the variable.
470 string GetString( in string theVarName );
473 /*! \brief Indicate if a variable is real
475 Return true if variable is real otherwise return false.
476 \param theVarName is a name of the variable.
478 boolean IsReal( in string theVarName );
480 /*! \brief Indicate if a variable is integer
482 Return true if variable is integer otherwise return false.
483 \param theVarName is a name of the variable.
485 boolean IsInteger( in string theVarName );
487 /*! \brief Indicate if a variable is boolean
489 Return true if variable is boolean otherwise return false.
490 \param theVarName is a name of the variable.
492 boolean IsBoolean( in string theVarName );
494 /*! \brief Indicate if a variable is string
496 Return true if variable is string otherwise return false.
497 \param theVarName is a name of the variable.
499 boolean IsString( in string theVarName );
501 /*! \brief Indicate if a variable exists in the study
503 Return true if variable exists in the study,
504 otherwise return false.
505 \param theVarName is a name of the variable.
507 boolean IsVariable( in string theVarName );
509 /*! \brief Get names of all variables from the study.
511 ListOfStrings GetVariableNames();
513 /*! \brief Remove a variable
515 Remove variable with the specified name from the study with substitution of its value.
517 \param theVarName Name of the variable.
518 \return Status of operation.
520 boolean RemoveVariable( in string theVarName );
522 /*! \brief Rename a variable
524 Rename variable with the specified name within the study.
526 \param theVarName Name of the variable.
527 \param theNewVarName New name for the variable.
528 \return Status of operation.
530 boolean RenameVariable( in string theVarName, in string theNewVarName );
532 /*! \brief Indicate whether variable is used
534 Check that variable is used in the study.
536 \param theVarName Name of the variable.
537 \return Variable usage.
539 boolean IsVariableUsed( in string theVarName );
541 /*! \brief Parse variables used for object creation
543 \param string with variables, separated by special symbol.
544 \return Variables list.
546 ListOfListOfStrings ParseVariables( in string theVars );
549 Attach an observer to the Study
553 void attach(in SALOMEDS::Observer theObserver, in boolean modify);
556 //==========================================================================
557 /*! \brief %Study Builder Interface
559 The purpose of the Builder is to add and/or remove objects and attributes.
560 A %StudyBuilder is linked to a %Study. A
561 command management is provided for the undo/redo functionalities.
563 <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
564 item's position in the tree-type structure of the browser. In general it has the following
565 form: <TT>0:2:1:1</TT>
567 //==========================================================================
569 interface StudyBuilder
571 /*! \brief %LockProtection Exception
573 This exception is raised while attempting to modify a locked %study.
575 exception LockProtection {};
576 /*! \brief Creation of a new %SComponent.
578 Creates a new %SComponent
579 \param ComponentDataType Data type of the %SComponent which will be created.
581 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
584 SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
585 /*! \brief Definition of the instance to the %SComponent
587 Defines the instance to the %SComponent.
589 void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
591 /*! \brief Deletion of a %SComponent
593 Removes a %SComponent.
595 void RemoveComponent(in SComponent aComponent) raises(LockProtection);
597 /*! \brief Creation of a new %SObject
599 Creates a new %SObject under a definite father %SObject.
601 \param theFatherObject The father %SObject under which this one should be created.
604 <em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
608 SObject NewObject (in SObject theFatherObject) raises(LockProtection);
610 /*! \brief Creation of a new %SObject with a definite %tag
612 Creates a new %SObject with a definite %tag.
614 \param atag Long value corresponding to the tag of the new %SObject.
618 SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
619 /*! \brief Deletion of the %SObject
621 Removes a %SObject from the %StudyBuilder.
623 \param anObject The %SObject to be deleted.
625 void RemoveObject (in SObject anObject) raises(LockProtection);
626 /*! \brief Deletion of the %SObject with all his child objects.
628 Removes the %SObject with all his child objects.
630 \param anObject The %SObject to be deleted with all child objects.
632 void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
637 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
640 void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
644 \param sco %SObject to be loaded.
646 void Load (in SObject sco);
648 /*! \brief Looking for or creating an attribute assigned to the %SObject
650 Allows to find or create an attribute of a specific type which is assigned to the object.
651 \param anObject The %SObject corresponding to the attribute which is looked for.
652 \param aTypeOfAttribute Type of the attribute.
654 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
657 GenericAttribute FindOrCreateAttribute(in SObject anObject,
658 in string aTypeOfAttribute) raises(LockProtection);
660 /*! \brief Looking for an attribute assigned to a %SObject
662 Allows to find an attribute of a specific type which is assigned to the object.
663 \param anObject The %SObject corresponding to the attribute which is looked for.
664 \param aTypeOfAttribute Type of the attribute.
665 \param anAttribute Where the attribute is placed if it's found.
666 \return True if it finds an attribute.
669 boolean FindAttribute(in SObject anObject,
670 out GenericAttribute anAttribute,
671 in string aTypeOfAttribute);
672 /*! \brief Deleting the attribute assigned to the %SObject
674 Removes the attribute of a specific type which is assigned to the object.
675 \param anObject The %SObject corresponding to the attribute.
676 \param aTypeOfAttribute Type of the attribute.
678 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
680 void RemoveAttribute(in SObject anObject,
681 in string aTypeOfAttribute) raises(LockProtection);
683 Adds a reference between %anObject and %theReferencedObject.
684 \param anObject The %SObject which will get a reference
685 \param theReferencedObject The %SObject having a reference
688 void Addreference(in SObject anObject,
689 in SObject theReferencedObject) ;
692 Removes a reference from %anObject to another object.
693 \param anObject The %SObject which contains a reference
696 void RemoveReference(in SObject anObject) ;
699 Adds a directory in the %Study.
700 \param theName String parameter defining the name of the directory.
702 <em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
705 void AddDirectory(in string theName) raises(LockProtection);
707 /*! \brief Identification of the %SObject's substructure.
709 Identification of the %SObject's substructure by GUID.
712 \param anObject The %SObject which will be identified
713 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
716 void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
718 Searches for a definite %SObject with a definite GUID and returns True if it finds it.
720 \param anObject A definite %SObject which will be identified
721 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
723 boolean IsGUID(in SObject anObject, in string theGUID);
725 /*! \brief Creation of a new command
727 Creates a new command which can contain several different actions.
729 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
732 void NewCommand(); // command management
733 /*! \brief Execution of the command
735 Commits all actions declared within this command.
737 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
739 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
742 void CommitCommand() raises(LockProtection); // command management
744 Returns True if at this moment there is a command under execution.
746 boolean HasOpenCommand();
747 /*! \brief Cancelation of the command
749 Cancels all actions declared within the command.
751 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
753 void AbortCommand(); // command management
756 The number of actions which can be undone
758 attribute long UndoLimit;
759 /*! \brief Undo method
761 Cancels all actions of the last command.
763 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
765 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
768 void Undo() raises (LockProtection);
769 /*! \brief Redo method
771 Redoes all actions of the last command.
773 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
775 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
778 void Redo() raises (LockProtection);
780 Returns True if at this moment there are any actions which can be canceled.
782 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
785 boolean GetAvailableUndos();
787 Returns True if at this moment there are any actions which can be redone.
789 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
792 boolean GetAvailableRedos();
794 Puts name attribute with the given string value to the given %SObject
796 \param theSO Existing SObject to set name attribute.
797 \param theValue The value to be set to the name attribute.
799 void SetName(in SObject theSO, in string theValue) raises (LockProtection);
802 Puts comment attribute with the given string value to the given %SObject
804 \param theSO Existing SObject to set comment attribute.
805 \param theValue The value to be set to the comment attribute.
807 void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
810 Puts IOR attribute with the given string value to the given %SObject
812 \param theSO Existing SObject to set IOR attribute.
813 \param theValue The value to be set to the IOR attribute.
815 void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
818 //==========================================================================
819 /*! \brief %Study Manager interface
821 The purpose of the Manager is to manipulate the %Studies. You will find in this
822 interface the methods to create, open,
823 close, and save a %Study. Since a %SALOME session is multi-document, you will
824 also find the methods allowing to navigate
825 through the collection of studies present in a session.
827 //==========================================================================
829 interface StudyManager
832 Determines whether the server has already been loaded or not.
839 Returns the PID of the server
844 Shutdown the StudyManager process.
846 oneway void ShutdownWithExit();
848 /*! \brief Creation of a new study
850 Creates a new study with a definite name.
852 \param study_name String parameter defining the name of the study
854 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
857 Study NewStudy(in string study_name);
859 /*! \brief Open a study
861 Reads and activates the structure of the study %Objects.
862 \param aStudyUrl The path to the study
863 \warning This method doesn't activate the corba objects. Only a component can do it.
865 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
867 Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
869 /*! \brief Closing the study
873 void Close(in Study aStudy);
874 /*! \brief Saving the study in a HDF file (or files).
878 \param theMultiFile If this parameter is True the study will be saved in several files.
880 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
883 boolean Save(in Study aStudy, in boolean theMultiFile);
884 /*! \brief Saving a study in a ASCII file (or files).
886 Saves a study in an ASCII format file (or files).
887 \param theMultiFile If this parameter is True the study will be saved in several files.
889 boolean SaveASCII(in Study aStudy, in boolean theMultiFile);
890 /*! \brief Saving the study in a specified HDF file (or files).
892 Saves the study in a specified file (or files).
893 \param aUrl The path to the definite file in whcih the study will be saved
894 \param aStudy The study which will be saved
895 \param theMultiFile If this parameter is True the study will be saved in several files.
897 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
899 boolean SaveAs(in URL aUrl, // if the file already exists
901 in boolean theMultiFile); // overwrite (as option)
902 /*! \brief Saving the study in a specified ASCII file (or files).
904 Saves the study in a specified ASCII file (or files).
906 \param aUrl The path to the definite file in whcih the study will be saved
907 \param aStudy The study which will be saved
908 \param theMultiFile If this parameter is True the study will be saved in several files.
910 boolean SaveAsASCII(in URL aUrl, // if the file already exists
912 in boolean theMultiFile); // overwrite (as option)
915 /*! \brief List of open studies.
917 Gets the list of open studies
919 \return A list of open studies in the current session.
921 ListOfOpenStudies GetOpenStudies();
923 /*! \brief Getting a particular %Study picked by name
925 Activates a particular %Study
926 among the session collection picking it by name.
927 \param aStudyName The name of the study
929 Study GetStudyByName (in string aStudyName);
931 /*! \brief Getting a particular %Study picked by ID
933 Activates a particular %Study
934 among the session collection picking it by ID.
935 \param aStudyID The ID of the study
937 Study GetStudyByID (in short aStudyID);
939 // copy/paste methods
942 Returns True, if the given %SObject can be copied to the clipboard.
944 boolean CanCopy(in SObject theObject);
946 Returns True, if the given %SObject is copied to the clipboard.
947 \param theObject The %SObject which will be copied
949 boolean Copy(in SObject theObject);
951 Returns True, if the object from the clipboard can be pasted to the given %SObject.
952 \param theObject The %SObject stored in the clipboard.
954 boolean CanPaste(in SObject theObject);
956 Returns the %SObject in which the object from the clipboard was pasted to.
957 \param theObject The %SObject which will be pasted
958 \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
959 an object into a study, which is protected for modifications.
961 SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
963 /*! \brief Object conversion.
965 Converts an object into IOR.
968 string ConvertObjectToIOR(in Object theObject);
969 /*! \brief Object conversion.
971 Converts IOR into an object.
974 Object ConvertIORToObject(in string theIOR);
977 Private method, returns an implementation of this StudyManager.
978 \param theHostname is a hostname of the caller
979 \param thePID is a process ID of the caller
980 \param isLocal is set True if the StudyManager is launched locally with the caller
982 long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
988 //==========================================================================
989 /*! \brief %SObject interface
991 The objects in the %study are built by the %StudyBuilder. The %SObject interface
992 provides methods for elementary inquiries, like getting an object %ID or its attribuites.
995 <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
996 in the tree-type data structure.
997 <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
998 ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
1000 //==========================================================================
1002 interface SObject : SALOME::GenericObj
1004 /*! Name of the %SObject
1006 attribute string Name; // equivalent to setName() & getName()
1008 /*! Returns true if the %SObject does not belong to any %Study
1012 /*! Gets an object %ID
1014 \return ID of the %SObject.
1017 /*! Acquisition of the father %Component of the %SObject
1019 \return The father %Component of the %SObject.
1021 SComponent GetFatherComponent();
1022 /*! Acquisition of the father %SObject of the %SObject
1024 \return the father %SObject of the given %SObject.
1026 SObject GetFather();
1027 /*! Gets the %tag of a %SObject
1029 \return the %tag of a %SObject.
1032 /*! Gets the depth of a %SObject
1034 \return the depth of a %SObject.
1037 /*! Looks for subobjects of a given %SObject.
1039 \param atag Tag of the given %SObject
1040 \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
1043 boolean FindSubObject (in long atag, out SObject obj);
1044 /*! Looks for attributes of a given %SObject
1046 \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
1047 \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
1049 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
1051 boolean FindAttribute(out GenericAttribute anAttribute,
1052 in string aTypeOfAttribute);
1053 /*! Looks for a %SObject which the given %SObject refers to.
1055 \return The object which the given %SObject refers to as well as True if it finds
1058 boolean ReferencedObject(out SObject obj); // A REVOIR
1059 /*! Gets all attributes of a given %SObject
1061 \return The list of all attributes of the given %SObject.
1063 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
1066 ListOfAttributes GetAllAttributes();
1067 /*! Gets the study of a given %SObject.
1069 \return The study containing the given %SObject.
1073 /*! Gets the CORBA object by its own IOR attribute.
1074 Returns nil, if can't.
1076 \return The CORBA object of the %SObject.
1081 Returns the name attribute value of this SObject.
1082 Returns empty string if there is no name attribute.
1087 Returns the comment attribute value of this SObject.
1088 Returns empty string if there is no comment attribute.
1090 string GetComment();
1093 Returns the IOR attribute value of this SObject.
1094 Returns empty string if there is no IOR attribute.
1099 Set an attribute value (of type string)
1100 \param name the name of the attribute
1101 \param value the value of the attribute
1103 void SetAttrString(in string name, in string value);
1106 Private method, returns an implementation of this SObject.
1107 \param theHostname is a hostname of the caller
1108 \param thePID is a process ID of the caller
1109 \param isLocal is set True if the SObject is launched locally with the caller
1111 long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1115 //==========================================================================
1116 /*! \brief %Generic attribute interface
1118 %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
1120 //==========================================================================
1121 interface GenericAttribute : SALOME::GenericObj
1123 /*! \brief Exception locking all changes
1125 This exception locks all modifications in attributes.
1127 exception LockProtection {};
1128 /*! \brief Method CheckLocked
1130 Checks whether the %Study is protected for modifications.
1132 \note <BR>This exception is raised only outside a transaction.
1134 void CheckLocked() raises (LockProtection);
1139 //! Get the class type
1140 string GetClassType();
1143 SObject GetSObject();
1145 //! Private method, returns an implementation of this GenericAttribute.
1147 \param theHostname is a hostname of the caller
1148 \param thePID is a process ID of the caller
1149 \param isLocal is set True if the GenericAttribute is launched locally with the caller
1151 long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1156 //==========================================================================
1157 /*! \brief %SComponent interface
1159 The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
1160 The %SComponent interface is a specialization of the %SObject interface.
1161 It inherits the most of its methods from the %SObject interface.
1163 //==========================================================================
1164 interface SComponent : SObject
1166 /*! \brief Gets the data type of the given %SComponent
1168 \return The data type of this %SComponent.
1170 string ComponentDataType();
1171 /*! \brief Gets the IOR of the given component
1173 \return True (if there is an instance of the given component) and its IOR.
1175 boolean ComponentIOR (out ID theID); //returns True if there is an instance
1176 //In this case ID identifies this one
1180 //==========================================================================
1181 /*! \brief %SComponentIterator interface
1183 This interface contains the methods allowing to iterate over all components in the list.
1184 The search is started from the first %SComponent in the list.
1186 //==========================================================================
1187 interface SComponentIterator : SALOME::GenericObj
1190 \brief Activates the %SComponentIterator.
1193 /*! \brief Method More
1195 \return True if there is one more %SComponent in the list.
1199 \brief Moves the iterator to the next %SComponent in the list.
1203 \brief Returns the %SComponent corresponding to the current %SComponent found by the iterator.
1205 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
1211 //==========================================================================
1212 /*! \brief %ChildIterator interface
1214 This interface contains methods which allow to iterate over all child
1217 //==========================================================================
1218 interface ChildIterator : SALOME::GenericObj
1222 \brief Activates the %ChildIterator.
1227 \brief Activates the %ChildIterator for all child levels.
1229 \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
1231 void InitEx(in boolean allLevels);
1232 /*! \brief Method More
1234 \return True if there is one more %ChildIterator in the list.
1238 \brief Passes the iterator to the next level.
1242 \brief Returns the %SObject corresponding to the current object found by the iterator.
1247 //==========================================================================
1248 //==========================================================================
1249 /*! \brief Interface of the %UseCaseIterator.
1251 This interface contains a set of methods used for iteration over the objects in the use case.
1253 interface UseCaseIterator : SALOME::GenericObj
1256 Activates the %UseCaseIterator.
1257 \param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
1259 void Init(in boolean allLevels);
1262 \return True if the %UseCaseIterator finds one more object.
1266 Passes the iterator to the next object.
1270 Returns the %SObject corresponding to the current object found by the Iterator.
1275 //==========================================================================
1276 //==========================================================================
1277 /*! \brief Interface of the %UseCaseBuilder
1279 Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1280 The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1282 interface UseCaseBuilder : SALOME::GenericObj
1285 Adds to the use case an object as a child of the current object of the use case.
1287 \param theObject The added %SObject.
1288 \return True if this %SObject has been added in the use case.
1290 boolean Append(in SObject theObject);
1292 Removes an object from the use case.
1294 \param theObject The deleted %SObject
1295 \return True if this %SObject has been deleted from the use case.
1297 boolean Remove(in SObject theObject);
1299 Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1301 boolean AppendTo(in SObject theFather, in SObject theObject);
1303 Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1305 boolean InsertBefore(in SObject theFirst, in SObject theNext);
1307 Sets the current object of the use case.
1309 boolean SetCurrentObject(in SObject theObject);
1311 Makes the root object to be the current object of the use case.
1313 boolean SetRootCurrent();
1315 Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1317 boolean HasChildren(in SObject theObject);
1319 Sets the name of the use case.
1321 boolean SetName(in string theName);
1323 Gets the name of the use case.
1327 Returns True if the given object <VAR>theObject</VAR> represents a use case.
1329 boolean IsUseCase(in SObject theObject);
1331 Gets the current object of the use case.
1333 SObject GetCurrentObject();
1335 Creates a new use case in the use case browser.
1337 SObject AddUseCase(in string theName);
1339 Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1341 UseCaseIterator GetUseCaseIterator(in SObject theObject);
1343 //==========================================================================
1344 /*! \brief %Driver interface
1346 This class represents a common tool for all components integrated into SALOME application, that allows them to communicate with the study. It contains a set of methods which
1347 can be called by any component and which provide the following functionality:
1349 <li> publishing in the study of the objects created by a definite component
1350 <li> saving/loading of the data created by a definite component. These methods are called by the StudyManager when loading/saving a study containing the data created by a definite component.
1351 <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
1352 <li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
1356 //==========================================================================
1360 /*! \brief Saving the data produced by a definite component.
1362 This method is called by the StudyManager when saving a study.
1363 \param theComponent %SComponent corresponding to this Component
1364 \param theURL The path to the file in which the data will be saved.
1365 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1366 \return A byte stream TMPFile that contains all saved data
1368 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1373 TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1375 /*! \brief Saving the data in ASCII format produced by a definite component.
1377 This method is called by the StudyManager when saving a study in ASCII format.
1378 \param theComponent %SComponent corresponding to this Component
1379 \param theURL The path to the file in which the data will be saved.
1380 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1381 \return A byte stream TMPFile that will contain all saved data
1383 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1386 TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1388 /*! \brief Loading the data.
1390 This method is called by the StudyManager when opening a study.
1391 \param theComponent %SComponent corresponding to this Component
1392 \param theStream The file which contains all data saved by the component on Save method
1393 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1397 boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1399 /*! \brief Loading the data from files in ASCII format.
1401 This method is called by the StudyManager when opening a study.
1402 \param theComponent %SComponent corresponding to this Component
1403 \param theStream The file which contains all data saved by the component on Save method
1404 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1408 boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1410 /*! \brief Closing of the study
1412 This method Close is called by the StudyManager when closing a study.
1413 \param aSComponent The according %SComponent
1416 void Close (in SComponent aSComponent);
1417 //void Close ( in string aIORSComponent);
1419 /*! Gets the type of the data
1421 \return The type of data produced by the Component in the study.
1424 string ComponentDataType();
1426 // Driver Transient -> persistent called for each object in study
1428 Transforms IOR of a given %SObject into PersistentID. It is called for each
1429 object in the %study.
1430 \note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
1431 study is saved these references are transformed into persintent IDs.
1433 \param theSObject The given %SObject.
1434 \param IORString The IOR of the given %SObject.
1435 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1436 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1438 \return The persistent ID of the given %SObject
1441 string IORToLocalPersistentID (in SObject theSObject,
1442 in string IORString,
1443 in boolean isMultiFile,
1444 in boolean isASCII);
1446 Transforms PersistentID into IOR of the object. It is called for each
1447 object in the %study.
1449 \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
1450 study is open, these references are transformed into persintent IORs.
1452 \param theSObject The given %SObject.
1453 \param IORString The IOR of the given %SObject.
1454 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1455 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1457 \return The IOR of the given %SObject
1460 string LocalPersistentIDToIOR (in SObject theSObject,
1461 in string aLocalPersistentID,
1462 in boolean isMultiFile,
1464 raises (SALOME::SALOME_Exception);
1466 // Publishing in the study
1467 /*! Publishing in the study
1469 \return True if the given %Component can publish a definite object with a given IOR in the %study.
1470 \param theIOR The IOR of a definite object
1472 boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1473 /*! \brief Publishing in the study
1475 Publishes the given object in the %study, using the algorithm of this component.
1476 \param theStudy The %study in which the object is published
1477 \param theSObject If this parameter is null the object is published for the first time. Otherwise
1478 this parameter should contain a reference to the object published earlier
1479 \param theObject The object which is published
1480 \param theName The name of the published object. If this parameter is empty, the name is generated
1481 automatically by the component.
1483 \return The published %SObject.
1485 SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
1487 // copy/paste methods
1490 Returns True, if the given %SObject can be copied to the clipboard.
1492 \param theObject The given %SObject which should be copied.
1494 boolean CanCopy(in SObject theObject);
1496 Returns the object %ID and the %TMPFile of the object from the given %SObject.
1498 TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1500 Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1502 boolean CanPaste(in string theComponentName, in long theObjectID);
1504 Returns the %SObject of the pasted object.
1506 SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);