1 // Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License.
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SALOMEDS.idl
23 // Author : Yves FRICAUD
27 \image html Application-About.png
31 \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment
32 and modification of the %Study
35 #ifndef _SALOMEDS_IDL_
36 #define _SALOMEDS_IDL_
38 #include "SALOME_Exception.idl"
39 #include "SALOME_GenericObj.idl"
42 This package contains the interfaces used for creation, managment
43 and modification of the %Study
48 Name of the file in which the %Study is saved.
53 /*! Main identifier of an object in %SALOME application
57 /*! While saving the data, IOR is transformed into persistent reference
59 typedef string PersistentReference;
61 /*! IOR of the study in %SALOME application
63 typedef string SalomeReference;
65 /*! List of the names of studies which are currently open in this %SALOME session.
66 Since %SALOME is a multi-study application, it allows to open a lot of studies
67 during each working session.
69 typedef sequence<string> ListOfOpenStudies;
70 /*! List of file names
72 typedef sequence<string> ListOfFileNames;
73 /*! List of modification dates of a study
75 typedef sequence<string> ListOfDates ;
76 /*! An unbounded sequence of strings
78 typedef sequence<string> ListOfStrings ;
79 /*! A byte stream which is used for binary data transfer between different components
81 typedef sequence<octet> TMPFile;
83 // Reference to other objects is treated with function AddReference
84 // and ReferencedObject
85 // All other type of attributes defined in AttributeType enum are
86 // treated with AddAdttribute and GetAttribute
87 // The difference is made because Reference attribute don't contain
88 // strings but reference to ID of other objects
90 interface GenericAttribute;
92 interface StudyManager;
93 interface StudyBuilder;
96 interface SComponentIterator;
97 interface ChildIterator;
99 interface AttributeStudyProperties;
100 interface AttributeParameter;
101 interface UseCaseIterator;
102 interface UseCaseBuilder;
104 /*! List of attributes of %SObjects
106 typedef sequence<GenericAttribute> ListOfAttributes;
108 /*! Exception indicating that this feature hasn't been implemented in %SALOME PRO application.
110 exception NotImplemented {};
113 //===========================================================================
114 /*! \brief %Study Interface
116 The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
117 Most of the %Study operations are handled by the StudyManager and the StudyBuilder.
118 What is left in the %Study interface are elementary inquiries.
119 (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
120 and set methods.) A %Study is explored by a set of tools, mainly iterators
121 , which are described further. Nevertheless, the %Study
122 interface allows the search of an object by name or by ID.
124 <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
125 In general it's a string of names of directories divided by a slash '/'.
126 <BR><VAR>The Context</VAR> is the current directory of an object.</P>
132 exception StudyInvalidContext {};
133 exception StudyInvalidComponent {};
134 /*! Invalid directory of the %study exception
136 exception StudyInvalidDirectory {};
137 /*! Exception pointing that this name of the study has already been used.
139 exception StudyNameAlreadyUsed {};
140 exception StudyObjectAlreadyExists {};
141 /*! Invalid name of the %study exception
143 exception StudyNameError {};
144 exception StudyCommentError {};
145 /*! \brief The name of the %Study
147 This is equivalent to the methods setName() & getName()
149 attribute string Name; // equivalent to setName() & getName()
150 /*! \brief The ID of the %Study
152 This is equivalent to the methods setID() & getID()
154 attribute short StudyId;
155 /*! Sequence containing %SObjects
157 typedef sequence<SObject> ListOfSObject;
159 Gets the persistent reference to the %Study.
161 PersistentReference GetPersistentReference();
163 Gets a transient reference to the %Study.
165 SalomeReference GetTransientReference();
168 Returns True if the %Study is empty
172 Allows to find a %SComponent by its name.
173 \param aComponentName It's a string value in the Comment Attribute of the Component,
174 which is looked for, defining the data type of this Component.
176 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
178 SComponent FindComponent (in string aComponentName);
180 Allows to find a %SComponent by ID of the according %SObject
182 SComponent FindComponentID(in ID aComponentID);
184 Allows to find a %SObject by the Name Attribute of this %SObject
186 \param anObjectName String parameter defining the name of the object
187 \return The obtained %SObject
189 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
192 SObject FindObject (in string anObjectName);
194 Allows to find a %SObject by its ID
195 \param aObjectID This parameter defines the ID of the required object
196 \return The obtained %SObject
199 SObject FindObjectID (in ID aObjectID);
201 Allows to create a %SObject by its ID
202 \param aObjectID This parameter defines the ID of the required object
203 \return The created %SObject
206 SObject CreateObjectID (in ID aObjectID);
208 Allows to find a %SObject by IOR of the object belonging to this %SObject.
209 \param anObjectName This parameter defines the IOR of the object
210 \return The obtained %SObject
213 SObject FindObjectIOR (in ID aObjectIOR);
215 Finds in the study all %SObjects produced by a given %Component.
216 \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
217 \param aComponentName The name of the component, which objects are searched for.
219 ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
221 Allows to find a %SObject by the path to it.
223 \param thePath The path to the required %SObject.
224 \return The obtained %SObject.
227 SObject FindObjectByPath(in string thePath);
229 Returns the path to the %SObject.
231 string GetObjectPath(in Object theObject);
234 Sets the context of the %Study.
235 \param thePath String parameter defining the context of the study.
237 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
240 void SetContext(in string thePath);
242 Gets the context of the %Study.
244 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
249 Returns a list of names of objects corresponding to the context.
250 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
252 ListOfStrings GetObjectNames(in string theContext);
254 Returns a list of names of directories and subdirectories corresponding to the context.
255 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
257 ListOfStrings GetDirectoryNames(in string theContext);
259 Returns a list of names of Files corresponding to the context.
260 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
262 ListOfStrings GetFileNames(in string theContext);
264 Returns a list of names of Components corresponding to the context.
265 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
267 ListOfStrings GetComponentNames(in string theContext);
269 Creates a new iterator of child levels of the given %SObject.
270 \param aSO The given %SObject
271 \return A new iterator of child levels of the given %SObject.
273 ChildIterator NewChildIterator(in SObject aSO);
276 Creates a new iterator of the %SComponents.
278 \return A new iterator of the %SComponents.
280 SComponentIterator NewComponentIterator();
282 Creates a new %StudyBuilder to add or modify an object in the study.
284 \return A new %StudyBuilder.
286 <BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
289 StudyBuilder NewBuilder() ;
290 /*! \brief Labels dependency
292 Updates the map with IOR attribute. It's an inner method used for optimization.
294 void UpdateIORLabelMap(in string anIOR, in string anEntry);
296 /*! \brief Getting properties of the study
298 Returns the attriubte, which contains the properties of this study.
300 <BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
303 AttributeStudyProperties GetProperties();
305 Determines whether the %study has been saved
307 attribute boolean IsSaved;
309 Returns True if the %study has been modified and not saved.
311 boolean IsModified();
313 Determines the file where the %study has been saved
315 attribute string URL;
317 /*! \brief List of %SObjects
319 Returns the list of %SObjects which refers to %anObject.
321 ListOfSObject FindDependances(in SObject anObject);
323 /*! \brief The date of the last saving of the study
325 Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
327 string GetLastModificationDate();
328 /*! \brief The list of modification dates of the study
330 Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
331 Note : the first modification begins the list.
333 ListOfDates GetModificationsDate();
334 /*! \brief Object conversion.
336 Converts an object into IOR.
339 string ConvertObjectToIOR(in Object theObject);
340 /*! \brief Object conversion.
342 Converts IOR into an object.
345 Object ConvertIORToObject(in string theIOR);
347 Gets a new %UseCaseBuilder.
349 UseCaseBuilder GetUseCaseBuilder();
352 Closes the components in the study, removes itself from the %StudyManager.
357 Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case.
359 void EnableUseCaseAutoFilling(in boolean isEnabled);
362 Functions for internal usage only
364 void AddPostponed(in string theIOR);
366 void AddCreatedPostponed(in string theIOR);
368 void RemovePostponed(in long theUndoLimit);
370 void UndoPostponed(in long theWay);
372 boolean DumpStudy(in string thePath, in string theBaseName, in boolean isPublished);
375 Returns an AttributeParameter used to store common parameters for given %theSavePoint.
376 \param theID identifies a common parameters set (Example: "Interface Applicative")
377 \param theSavePoint is number of a set of parameters as there can be several sets
379 AttributeParameter GetCommonParameters(in string theID, in long theSavePoint);
382 Returns an AttributeParameter used to store parameters for given %theModuleName.
383 \param theID identifies a common parameters set (Example: "Interface Applicative")
384 \param theModuleName is a name of the module (Example: "Geometry")
385 \param theSavePoint is number of a set of parameters as there can be several sets
387 AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint);
391 Returns a default Python script to restore visual parameters for given %theModuleName.
392 \param theID identifies a common parameters set (Example: "Interface Applicative")
393 \param theModuleName is a name of the module (Example: "Geometry")
395 string GetDefaultScript(in string theID, in string theModuleName);
398 Private method, returns an implementation of this Study.
399 \param theHostname is a hostname of the caller
400 \param thePID is a process ID of the caller
401 \param isLocal is set True if the Study is launched locally with the caller
403 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
407 //==========================================================================
408 /*! \brief %Study Builder Interface
410 The purpose of the Builder is to add and/or remove objects and attributes.
411 A %StudyBuilder is linked to a %Study. A
412 command management is provided for the undo/redo functionalities.
414 <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
415 item's position in the tree-type structure of the browser. In general it has the following
416 form: <TT>0:2:1:1</TT>
418 //==========================================================================
420 interface StudyBuilder
422 /*! \brief %LockProtection Exception
424 This exception is raised while attempting to modify a locked %study.
426 exception LockProtection {};
427 /*! \brief Creation of a new %SComponent.
429 Creates a new %SComponent
430 \param ComponentDataType Data type of the %SComponent which will be created.
432 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
435 SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
436 /*! \brief Definition of the instance to the %SComponent
438 Defines the instance to the %SComponent.
440 void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
442 /*! \brief Deletion of a %SComponent
444 Removes a %SComponent.
446 void RemoveComponent(in SComponent aComponent) raises(LockProtection);
448 /*! \brief Creation of a new %SObject
450 Creates a new %SObject under a definite father %SObject.
452 \param theFatherObject The father %SObject under which this one should be created.
455 <BR><VAR>See also <A href=exemple/Example18.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
459 SObject NewObject (in SObject theFatherObject) raises(LockProtection);
461 /*! \brief Creation of a new %SObject with a definite %tag
463 Creates a new %SObject with a definite %tag.
465 \param atag Long value corresponding to the tag of the new %SObject.
469 SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
470 /*! \brief Deletion of the %SObject
472 Removes a %SObject from the %StudyBuilder.
474 \param anObject The %SObject to be deleted.
476 void RemoveObject (in SObject anObject) raises(LockProtection);
477 /*! \brief Deletion of the %SObject with all his child objects.
479 Removes the %SObject with all his child objects.
481 \param anObject The %SObject to be deleted with all child objects.
483 void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
488 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
491 void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
495 \param sco %SObject to be loaded.
497 void Load (in SObject sco);
499 /*! \brief Looking for or creating an attribute assigned to the %SObject
501 Allows to find or create an attribute of a specific type which is assigned to the object.
502 \param anObject The %SObject corresponding to the attribute which is looked for.
503 \param aTypeOfAttribute Type of the attribute.
505 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
508 GenericAttribute FindOrCreateAttribute(in SObject anObject,
509 in string aTypeOfAttribute) raises(LockProtection);
511 /*! \brief Looking for an attribute assigned to a %SObject
513 Allows to find an attribute of a specific type which is assigned to the object.
514 \param anObject The %SObject corresponding to the attribute which is looked for.
515 \param aTypeOfAttribute Type of the attribute.
516 \param anAttribute Where the attribute is placed if it's found.
517 \return True if it finds an attribute.
520 boolean FindAttribute(in SObject anObject,
521 out GenericAttribute anAttribute,
522 in string aTypeOfAttribute);
523 /*! \brief Deleting the attribute assigned to the %SObject
525 Removes the attribute of a specific type which is assigned to the object.
526 \param anObject The %SObject corresponding to the attribute.
527 \param aTypeOfAttribute Type of the attribute.
529 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
531 void RemoveAttribute(in SObject anObject,
532 in string aTypeOfAttribute) raises(LockProtection);
534 Adds a reference between %anObject and %theReferencedObject.
535 \param anObject The %SObject which will get a reference
536 \param theReferencedObject The %SObject having a reference
539 void Addreference(in SObject anObject,
540 in SObject theReferencedObject) ;
543 Removes a reference from %anObject to another object.
544 \param anObject The %SObject which contains a reference
547 void RemoveReference(in SObject anObject) ;
550 Adds a directory in the %Study.
551 \param theName String parameter defining the name of the directory.
553 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
556 void AddDirectory(in string theName) raises(LockProtection);
558 /*! \brief Identification of the %SObject's substructure.
560 Identification of the %SObject's substructure by GUID.
563 \param anObject The %SObject which will be identified
564 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
567 void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
569 Searches for a definite %SObject with a definite GUID and returns True if it finds it.
571 \param anObject A definite %SObject which will be identified
572 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
574 boolean IsGUID(in SObject anObject, in string theGUID);
576 /*! \brief Creation of a new command
578 Creates a new command which can contain several different actions.
580 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
583 void NewCommand(); // command management
584 /*! \brief Execution of the command
586 Commits all actions declared within this command.
588 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
590 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
593 void CommitCommand() raises(LockProtection); // command management
595 Returns True if at this moment there is a command under execution.
597 boolean HasOpenCommand();
598 /*! \brief Cancelation of the command
600 Cancels all actions declared within the command.
602 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
604 void AbortCommand(); // command management
607 The number of actions which can be undone
609 attribute long UndoLimit;
610 /*! \brief Undo method
612 Cancels all actions of the last command.
614 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
616 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
619 void Undo() raises (LockProtection);
620 /*! \brief Redo method
622 Redoes all actions of the last command.
624 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
626 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
629 void Redo() raises (LockProtection);
631 Returns True if at this moment there are any actions which can be canceled.
633 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
636 boolean GetAvailableUndos();
638 Returns True if at this moment there are any actions which can be redone.
640 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
643 boolean GetAvailableRedos();
645 Puts name attribute with the given string value to the given %SObject
647 \param theSO Existing SObject to set name attribute.
648 \param theValue The value to be set to the name attribute.
650 void SetName(in SObject theSO, in string theValue) raises (LockProtection);
653 Puts comment attribute with the given string value to the given %SObject
655 \param theSO Existing SObject to set comment attribute.
656 \param theValue The value to be set to the comment attribute.
658 void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
661 Puts IOR attribute with the given string value to the given %SObject
663 \param theSO Existing SObject to set IOR attribute.
664 \param theValue The value to be set to the IOR attribute.
666 void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
669 //==========================================================================
670 /*! \brief %Study Manager interface
672 The purpose of the Manager is to manipulate the %Studies. You will find in this
673 interface the methods to create, open,
674 close, and save a %Study. Since a %SALOME session is multi-document, you will
675 also find the methods allowing to navigate
676 through the collection of studies present in a session.
678 //==========================================================================
680 interface StudyManager
683 Determines whether the server has already been loaded or not.
687 /*! \brief Creation of a new study
689 Creates a new study with a definite name.
691 \param study_name String parameter defining the name of the study
693 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
696 Study NewStudy(in string study_name);
698 /*! \brief Open a study
700 Reads and activates the structure of the study %Objects.
701 \param aStudyUrl The path to the study
702 \warning This method doesn't activate the corba objects. Only a component can do it.
704 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
706 Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
708 /*! \brief Closing the study
712 void Close(in Study aStudy);
713 /*! \brief Saving the study in a HDF file (or files).
717 \param theMultiFile If this parameter is True the study will be saved in several files.
719 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
722 boolean Save(in Study aStudy, in boolean theMultiFile);
723 /*! \brief Saving a study in a ASCII file (or files).
725 Saves a study in an ASCII format file (or files).
726 \param theMultiFile If this parameter is True the study will be saved in several files.
728 boolean SaveASCII(in Study aStudy, in boolean theMultiFile);
729 /*! \brief Saving the study in a specified HDF file (or files).
731 Saves the study in a specified file (or files).
732 \param aUrl The path to the definite file in whcih the study will be saved
733 \param aStudy The study which will be saved
734 \param theMultiFile If this parameter is True the study will be saved in several files.
736 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
738 boolean SaveAs(in URL aUrl, // if the file already exists
740 in boolean theMultiFile); // overwrite (as option)
741 /*! \brief Saving the study in a specified ASCII file (or files).
743 Saves the study in a specified ASCII file (or files).
745 \param aUrl The path to the definite file in whcih the study will be saved
746 \param aStudy The study which will be saved
747 \param theMultiFile If this parameter is True the study will be saved in several files.
749 boolean SaveAsASCII(in URL aUrl, // if the file already exists
751 in boolean theMultiFile); // overwrite (as option)
754 /*! \brief List of open studies.
756 Gets the list of open studies
758 \return A list of open studies in the current session.
760 ListOfOpenStudies GetOpenStudies();
762 /*! \brief Getting a particular %Study picked by name
764 Activates a particular %Study
765 among the session collection picking it by name.
766 \param aStudyName The name of the study
768 Study GetStudyByName (in string aStudyName);
770 /*! \brief Getting a particular %Study picked by ID
772 Activates a particular %Study
773 among the session collection picking it by ID.
774 \param aStudyID The ID of the study
776 Study GetStudyByID (in short aStudyID);
778 // copy/paste methods
781 Returns True, if the given %SObject can be copied to the clipboard.
783 boolean CanCopy(in SObject theObject);
785 Returns True, if the given %SObject is copied to the clipboard.
786 \param theObject The %SObject which will be copied
788 boolean Copy(in SObject theObject);
790 Returns True, if the object from the clipboard can be pasted to the given %SObject.
791 \param theObject The %SObject stored in the clipboard.
793 boolean CanPaste(in SObject theObject);
795 Returns the %SObject in which the object from the clipboard was pasted to.
796 \param theObject The %SObject which will be pasted
797 \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
798 an object into a study, which is protected for modifications.
800 SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
802 /*! \brief Object conversion.
804 Converts an object into IOR.
807 string ConvertObjectToIOR(in Object theObject);
808 /*! \brief Object conversion.
810 Converts IOR into an object.
813 Object ConvertIORToObject(in string theIOR);
816 Private method, returns an implementation of this StudyManager.
817 \param theHostname is a hostname of the caller
818 \param thePID is a process ID of the caller
819 \param isLocal is set True if the StudyManager is launched locally with the caller
821 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
827 //==========================================================================
828 /*! \brief %SObject interface
830 The objects in the %study are built by the %StudyBuilder. The %SObject interface
831 provides methods for elementary inquiries, like getting an object %ID or its attribuites.
834 <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
835 in the tree-type data structure.
836 <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
837 ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
839 //==========================================================================
841 interface SObject : SALOME::GenericObj
843 /*! Name of the %SObject
845 attribute string Name; // equivalent to setName() & getName()
846 /*! Gets an object %ID
848 \return ID of the %SObject.
851 /*! Acquisition of the father %Component of the %SObject
853 \return The father %Component of the %SObject.
855 SComponent GetFatherComponent();
856 /*! Acquisition of the father %SObject of the %SObject
858 \return the father %SObject of the given %SObject.
861 /*! Gets the %tag of a %SObject
863 \return the %tag of a %SObject.
866 /*! Gets the depth of a %SObject
868 \return the depth of a %SObject.
871 /*! Looks for subobjects of a given %SObject.
873 \param atag Tag of the given %SObject
874 \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
877 boolean FindSubObject (in long atag, out SObject obj);
878 /*! Looks for attributes of a given %SObject
880 \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
881 \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
883 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
885 boolean FindAttribute(out GenericAttribute anAttribute,
886 in string aTypeOfAttribute);
887 /*! Looks for a %SObject which the given %SObject refers to.
889 \return The object which the given %SObject refers to as well as True if it finds
892 boolean ReferencedObject(out SObject obj); // A REVOIR
893 /*! Gets all attributes of a given %SObject
895 \return The list of all attributes of the given %SObject.
897 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
900 ListOfAttributes GetAllAttributes();
901 /*! Gets the study of a given %SObject.
903 \return The study containing the given %SObject.
907 /*! Gets the CORBA object by its own IOR attribute.
908 Returns nil, if can't.
910 \return The CORBA object of the %SObject.
915 Returns the name attribute value of this SObject.
916 Returns empty string if there is no name attribute.
921 Returns the comment attribute value of this SObject.
922 Returns empty string if there is no comment attribute.
927 Returns the IOR attribute value of this SObject.
928 Returns empty string if there is no IOR attribute.
933 Private method, returns an implementation of this SObject.
934 \param theHostname is a hostname of the caller
935 \param thePID is a process ID of the caller
936 \param isLocal is set True if the SObject is launched locally with the caller
938 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
942 //==========================================================================
943 /*! \brief %Generic attribute interface
945 %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
947 //==========================================================================
948 interface GenericAttribute : SALOME::GenericObj
950 /*! \brief Exception locking all changes
952 This exception locks all modifications in attributes.
954 exception LockProtection {};
955 /*! \brief Method CheckLocked
957 Checks whether the %Study is protected for modifications.
959 \note <BR>This exception is raised only outside a transaction.
961 void CheckLocked() raises (LockProtection);
965 string GetClassType();
967 SObject GetSObject();
970 Private method, returns an implementation of this GenericAttribute.
971 \param theHostname is a hostname of the caller
972 \param thePID is a process ID of the caller
973 \param isLocal is set True if the GenericAttribute is launched locally with the caller
975 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
980 //==========================================================================
981 /*! \brief %SComponent interface
983 The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
984 The %SComponent interface is a specialization of the %SObject interface.
985 It inherits the most of its methods from the %SObject interface.
987 //==========================================================================
988 interface SComponent : SObject
990 /*! Gets the data type of the given %SComponent
992 \return The data type of this %SComponent.
994 string ComponentDataType();
995 /*! Gets the IOR of the given component
997 \return True (if there is an instance of the given component) and its IOR.
999 boolean ComponentIOR (out ID theID); //returns True if there is an instance
1000 //In this case ID identifies this one
1004 //==========================================================================
1005 /*! \brief %SComponentIterator interface
1007 This interface contains the methods allowing to iterate over all components in the list.
1008 The search is started from the first %SComponent in the list.
1010 //==========================================================================
1011 interface SComponentIterator : SALOME::GenericObj
1014 Activates the %SComponentIterator.
1019 \return True if there is one more %SComponent in the list.
1023 Moves the iterator to the next %SComponent in the list.
1027 Returns the %SComponent corresponding to the current %SComponent found by the iterator.
1029 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1035 //==========================================================================
1036 /*! \brief %ChildIterator interface
1038 This interface contains methods which allow to iterate over all child
1041 //==========================================================================
1042 interface ChildIterator : SALOME::GenericObj
1046 Activates the %ChildIterator.
1051 Activates the %ChildIterator for all child levels.
1053 \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
1055 void InitEx(in boolean allLevels);
1058 \return True if there is one more %ChildIterator in the list.
1062 Passes the iterator to the next level.
1066 Returns the %SObject corresponding to the current object found by the iterator.
1071 //==========================================================================
1072 //==========================================================================
1073 /*! \brief Interface of the %UseCaseIterator.
1075 This interface contains a set of methods used for iteration over the objects in the use case.
1077 interface UseCaseIterator : SALOME::GenericObj
1080 Activates the %UseCaseIterator.
1081 \param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
1083 void Init(in boolean allLevels);
1086 \return True if the %UseCaseIterator finds one more object.
1090 Passes the iterator to the next object.
1094 Returns the %SObject corresponding to the current object found by the Iterator.
1099 //==========================================================================
1100 //==========================================================================
1101 /*! \brief Interface of the %UseCaseBuilder
1103 Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1104 The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1106 interface UseCaseBuilder : SALOME::GenericObj
1109 Adds to the use case an object as a child of the current object of the use case.
1111 \param theObject The added %SObject.
1112 \return True if this %SObject has been added in the use case.
1114 boolean Append(in SObject theObject);
1116 Removes an object from the use case.
1118 \param theObject The deleted %SObject
1119 \return True if this %SObject has been deleted from the use case.
1121 boolean Remove(in SObject theObject);
1123 Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1125 boolean AppendTo(in SObject theFather, in SObject theObject);
1127 Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1129 boolean InsertBefore(in SObject theFirst, in SObject theNext);
1131 Sets the current object of the use case.
1133 boolean SetCurrentObject(in SObject theObject);
1135 Makes the root object to be the current object of the use case.
1137 boolean SetRootCurrent();
1139 Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1141 boolean HasChildren(in SObject theObject);
1143 Sets the name of the use case.
1145 boolean SetName(in string theName);
1147 Gets the name of the use case.
1151 Returns True if the given object <VAR>theObject</VAR> represents a use case.
1153 boolean IsUseCase(in SObject theObject);
1155 Gets the current object of the use case.
1157 SObject GetCurrentObject();
1159 Creates a new use case in the use case browser.
1161 SObject AddUseCase(in string theName);
1163 Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1165 UseCaseIterator GetUseCaseIterator(in SObject theObject);
1167 //==========================================================================
1168 /*! \brief %Driver interface
1170 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
1171 can be called by any component and which provide the following functionality:
1173 <li> publishing in the study of the objects created by a definite component
1174 <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.
1175 <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
1176 <li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
1180 //==========================================================================
1184 /*! \brief Saving the data produced by a definite component.
1186 This method is called by the StudyManager when saving a study.
1187 \param theComponent %SComponent corresponding to this Component
1188 \param theURL The path to the file in which the data will be saved.
1189 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1190 \return A byte stream TMPFile that contains all saved data
1192 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1197 TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1199 /*! \brief Saving the data in ASCII format produced by a definite component.
1201 This method is called by the StudyManager when saving a study in ASCII format.
1202 \param theComponent %SComponent corresponding to this Component
1203 \param theURL The path to the file in which the data will be saved.
1204 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1205 \return A byte stream TMPFile that will contain all saved data
1207 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1210 TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1212 /*! \brief Loading the data.
1214 This method is called by the StudyManager when opening a study.
1215 \param theComponent %SComponent corresponding to this Component
1216 \param theStream The file which contains all data saved by the component on Save method
1217 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1221 boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1223 /*! \brief Loading the data from files in ASCII format.
1225 This method is called by the StudyManager when opening a study.
1226 \param theComponent %SComponent corresponding to this Component
1227 \param theStream The file which contains all data saved by the component on Save method
1228 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1232 boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1234 /*! \brief Closing of the study
1236 This method Close is called by the StudyManager when closing a study.
1237 \param aSComponent The according %SComponent
1240 void Close (in SComponent aSComponent);
1241 //void Close ( in string aIORSComponent);
1243 /*! Gets the type of the data
1245 \return The type of data produced by the Component in the study.
1248 string ComponentDataType();
1250 // Driver Transient -> persistent called for each object in study
1252 Transforms IOR of a given %SObject into PersistentID. It is called for each
1253 object in the %study.
1254 \note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
1255 study is saved these references are transformed into persintent IDs.
1257 \param theSObject The given %SObject.
1258 \param IORString The IOR of the given %SObject.
1259 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1260 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1262 \return The persistent ID of the given %SObject
1265 string IORToLocalPersistentID (in SObject theSObject,
1266 in string IORString,
1267 in boolean isMultiFile,
1268 in boolean isASCII);
1270 Transforms PersistentID into IOR of the object. It is called for each
1271 object in the %study.
1273 \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
1274 study is open, these references are transformed into persintent IORs.
1276 \param theSObject The given %SObject.
1277 \param IORString The IOR of the given %SObject.
1278 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1279 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1281 \return The IOR of the given %SObject
1284 string LocalPersistentIDToIOR (in SObject theSObject,
1285 in string aLocalPersistentID,
1286 in boolean isMultiFile,
1288 raises (SALOME::SALOME_Exception);
1290 // Publishing in the study
1291 /*! Publishing in the study
1293 \return True if the given %Component can publish a definite object with a given IOR in the %study.
1294 \param theIOR The IOR of a definite object
1296 boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1297 /*! \brief Publishing in the study
1299 Publishes the given object in the %study, using the algorithm of this component.
1300 \param theStudy The %study in which the object is published
1301 \param theSObject If this parameter is null the object is published for the first time. Otherwise
1302 this parameter should contain a reference to the object published earlier
1303 \param theObject The object which is published
1304 \param theName The name of the published object. If this parameter is empty, the name is generated
1305 automatically by the component.
1307 \return The published %SObject.
1309 SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
1311 // copy/paste methods
1314 Returns True, if the given %SObject can be copied to the clipboard.
1316 \param theObject The given %SObject which should be copied.
1318 boolean CanCopy(in SObject theObject);
1320 Returns the object %ID and the %TMPFile of the object from the given %SObject.
1322 TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1324 Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1326 boolean CanPaste(in string theComponentName, in long theObjectID);
1328 Returns the %SObject of the pasted object.
1330 SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);