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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
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 UseCaseIterator;
101 interface UseCaseBuilder;
103 /*! List of attributes of %SObjects
105 typedef sequence<GenericAttribute> ListOfAttributes;
107 /*! Exception indicating that this feature hasn't been implemented in %SALOME PRO application.
109 exception NotImplemented {};
112 //===========================================================================
113 /*! \brief %Study Interface
115 The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
116 Most of the %Study operations are handled by the StudyManager and the StudyBuilder.
117 What is left in the %Study interface are elementary inquiries.
118 (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
119 and set methods.) A %Study is explored by a set of tools, mainly iterators
120 , which are described further. Nevertheless, the %Study
121 interface allows the search of an object by name or by ID.
123 <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
124 In general it's a string of names of directories divided by a slash '/'.
125 <BR><VAR>The Context</VAR> is the current directory of an object.</P>
131 exception StudyInvalidContext {};
132 exception StudyInvalidComponent {};
133 /*! Invalid directory of the %study exception
135 exception StudyInvalidDirectory {};
136 /*! Exception pointing that this name of the study has already been used.
138 exception StudyNameAlreadyUsed {};
139 exception StudyObjectAlreadyExists {};
140 /*! Invalid name of the %study exception
142 exception StudyNameError {};
143 exception StudyCommentError {};
144 /*! \brief The name of the %Study
146 This is equivalent to the methods setName() & getName()
148 attribute string Name; // equivalent to setName() & getName()
149 /*! \brief The ID of the %Study
151 This is equivalent to the methods setID() & getID()
153 attribute short StudyId;
154 /*! Sequence containing %SObjects
156 typedef sequence<SObject> ListOfSObject;
158 Gets the persistent reference to the %Study.
160 PersistentReference GetPersistentReference();
162 Gets a transient reference to the %Study.
164 SalomeReference GetTransientReference();
167 Returns True if the %Study is empty
171 Allows to find a %SComponent by its name.
172 \param aComponentName It's a string value in the Comment Attribute of the Component,
173 which is looked for, defining the data type of this Component.
175 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
177 SComponent FindComponent (in string aComponentName);
179 Allows to find a %SComponent by ID of the according %SObject
181 SComponent FindComponentID(in ID aComponentID);
183 Allows to find a %SObject by the Name Attribute of this %SObject
185 \param anObjectName String parameter defining the name of the object
186 \return The obtained %SObject
188 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
191 SObject FindObject (in string anObjectName);
193 Allows to find a %SObject by its ID
194 \param aObjectID This parameter defines the ID of the required object
195 \return The obtained %SObject
198 SObject FindObjectID (in ID aObjectID);
200 Allows to create a %SObject by its ID
201 \param aObjectID This parameter defines the ID of the required object
202 \return The created %SObject
205 SObject CreateObjectID (in ID aObjectID);
207 Allows to find a %SObject by IOR of the object belonging to this %SObject.
208 \param anObjectName This parameter defines the IOR of the object
209 \return The obtained %SObject
212 SObject FindObjectIOR (in ID aObjectIOR);
214 Finds in the study all %SObjects produced by a given %Component.
215 \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
216 \param aComponentName The name of the component, which objects are searched for.
218 ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
220 Allows to find a %SObject by the path to it.
222 \param thePath The path to the required %SObject.
223 \return The obtained %SObject.
226 SObject FindObjectByPath(in string thePath);
228 Returns the path to the %SObject.
230 string GetObjectPath(in Object theObject);
233 Sets the context of the %Study.
234 \param thePath String parameter defining the context of the study.
236 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
239 void SetContext(in string thePath);
241 Gets the context of the %Study.
243 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
248 Returns a list of names of objects corresponding to the context.
249 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
251 ListOfStrings GetObjectNames(in string theContext);
253 Returns a list of names of directories and subdirectories corresponding to the context.
254 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
256 ListOfStrings GetDirectoryNames(in string theContext);
258 Returns a list of names of Files corresponding to the context.
259 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
261 ListOfStrings GetFileNames(in string theContext);
263 Returns a list of names of Components corresponding to the context.
264 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
266 ListOfStrings GetComponentNames(in string theContext);
268 Creates a new iterator of child levels of the given %SObject.
269 \param aSO The given %SObject
270 \return A new iterator of child levels of the given %SObject.
272 ChildIterator NewChildIterator(in SObject aSO);
275 Creates a new iterator of the %SComponents.
277 \return A new iterator of the %SComponents.
279 SComponentIterator NewComponentIterator();
281 Creates a new %StudyBuilder to add or modify an object in the study.
283 \return A new %StudyBuilder.
285 <BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
288 StudyBuilder NewBuilder() ;
289 /*! \brief Labels dependency
291 Updates the map with IOR attribute. It's an inner method used for optimization.
293 void UpdateIORLabelMap(in string anIOR, in string anEntry);
295 /*! \brief Getting properties of the study
297 Returns the attriubte, which contains the properties of this study.
299 <BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
302 AttributeStudyProperties GetProperties();
304 Determines whether the %study has been saved
306 attribute boolean IsSaved;
308 Returns True if the %study has been modified and not saved.
310 boolean IsModified();
312 Determines the file where the %study has been saved
314 attribute string URL;
316 /*! \brief List of %SObjects
318 Returns the list of %SObjects which refers to %anObject.
320 ListOfSObject FindDependances(in SObject anObject);
322 /*! \brief The date of the last saving of the study
324 Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
326 string GetLastModificationDate();
327 /*! \brief The list of modification dates of the study
329 Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
330 Note : the first modification begins the list.
332 ListOfDates GetModificationsDate();
333 /*! \brief Object conversion.
335 Converts an object into IOR.
338 string ConvertObjectToIOR(in Object theObject);
339 /*! \brief Object conversion.
341 Converts IOR into an object.
344 Object ConvertIORToObject(in string theIOR);
346 Gets a new %UseCaseBuilder.
348 UseCaseBuilder GetUseCaseBuilder();
351 Closes the components in the study, removes itself from the %StudyManager.
356 Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case.
358 void EnableUseCaseAutoFilling(in boolean isEnabled);
361 Functions for internal usage only
363 void AddPostponed(in string theIOR);
365 void AddCreatedPostponed(in string theIOR);
367 void RemovePostponed(in long theUndoLimit);
369 void UndoPostponed(in long theWay);
371 boolean DumpStudy(in string thePath, in string theBaseName, in boolean isPublished);
374 Private method, returns an implementation of this Study.
375 \param theHostname is a hostname of the caller
376 \param thePID is a process ID of the caller
377 \param isLocal is set True if the Study is launched locally with the caller
379 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
383 //==========================================================================
384 /*! \brief %Study Builder Interface
386 The purpose of the Builder is to add and/or remove objects and attributes.
387 A %StudyBuilder is linked to a %Study. A
388 command management is provided for the undo/redo functionalities.
390 <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
391 item's position in the tree-type structure of the browser. In general it has the following
392 form: <TT>0:2:1:1</TT>
394 //==========================================================================
396 interface StudyBuilder
398 /*! \brief %LockProtection Exception
400 This exception is raised while attempting to modify a locked %study.
402 exception LockProtection {};
403 /*! \brief Creation of a new %SComponent.
405 Creates a new %SComponent
406 \param ComponentDataType Data type of the %SComponent which will be created.
408 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
411 SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
412 /*! \brief Definition of the instance to the %SComponent
414 Defines the instance to the %SComponent.
416 void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
418 /*! \brief Deletion of a %SComponent
420 Removes a %SComponent.
422 void RemoveComponent(in SComponent aComponent) raises(LockProtection);
424 /*! \brief Creation of a new %SObject
426 Creates a new %SObject under a definite father %SObject.
428 \param theFatherObject The father %SObject under which this one should be created.
431 <BR><VAR>See also <A href=exemple/Example18.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
435 SObject NewObject (in SObject theFatherObject) raises(LockProtection);
437 /*! \brief Creation of a new %SObject with a definite %tag
439 Creates a new %SObject with a definite %tag.
441 \param atag Long value corresponding to the tag of the new %SObject.
445 SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
446 /*! \brief Deletion of the %SObject
448 Removes a %SObject from the %StudyBuilder.
450 \param anObject The %SObject to be deleted.
452 void RemoveObject (in SObject anObject) raises(LockProtection);
453 /*! \brief Deletion of the %SObject with all his child objects.
455 Removes the %SObject with all his child objects.
457 \param anObject The %SObject to be deleted with all child objects.
459 void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
464 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
467 void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
471 \param sco %SObject to be loaded.
473 void Load (in SObject sco);
475 /*! \brief Looking for or creating an attribute assigned to the %SObject
477 Allows to find or create an attribute of a specific type which is assigned to the object.
478 \param anObject The %SObject corresponding to the attribute which is looked for.
479 \param aTypeOfAttribute Type of the attribute.
481 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
484 GenericAttribute FindOrCreateAttribute(in SObject anObject,
485 in string aTypeOfAttribute) raises(LockProtection);
487 /*! \brief Looking for an attribute assigned to a %SObject
489 Allows to find an attribute of a specific type which is assigned to the object.
490 \param anObject The %SObject corresponding to the attribute which is looked for.
491 \param aTypeOfAttribute Type of the attribute.
492 \param anAttribute Where the attribute is placed if it's found.
493 \return True if it finds an attribute.
496 boolean FindAttribute(in SObject anObject,
497 out GenericAttribute anAttribute,
498 in string aTypeOfAttribute);
499 /*! \brief Deleting the attribute assigned to the %SObject
501 Removes the attribute of a specific type which is assigned to the object.
502 \param anObject The %SObject corresponding to the attribute.
503 \param aTypeOfAttribute Type of the attribute.
505 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
507 void RemoveAttribute(in SObject anObject,
508 in string aTypeOfAttribute) raises(LockProtection);
510 Adds a reference between %anObject and %theReferencedObject.
511 \param anObject The %SObject which will get a reference
512 \param theReferencedObject The %SObject having a reference
515 void Addreference(in SObject anObject,
516 in SObject theReferencedObject) ;
519 Removes a reference from %anObject to another object.
520 \param anObject The %SObject which contains a reference
523 void RemoveReference(in SObject anObject) ;
526 Adds a directory in the %Study.
527 \param theName String parameter defining the name of the directory.
529 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
532 void AddDirectory(in string theName) raises(LockProtection);
534 /*! \brief Identification of the %SObject's substructure.
536 Identification of the %SObject's substructure by GUID.
539 \param anObject The %SObject which will be identified
540 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
543 void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
545 Searches for a definite %SObject with a definite GUID and returns True if it finds it.
547 \param anObject A definite %SObject which will be identified
548 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
550 boolean IsGUID(in SObject anObject, in string theGUID);
552 /*! \brief Creation of a new command
554 Creates a new command which can contain several different actions.
556 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
559 void NewCommand(); // command management
560 /*! \brief Execution of the command
562 Commits all actions declared within this command.
564 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
566 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
569 void CommitCommand() raises(LockProtection); // command management
571 Returns True if at this moment there is a command under execution.
573 boolean HasOpenCommand();
574 /*! \brief Cancelation of the command
576 Cancels all actions declared within the command.
578 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
580 void AbortCommand(); // command management
583 The number of actions which can be undone
585 attribute long UndoLimit;
586 /*! \brief Undo method
588 Cancels all actions of the last command.
590 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
592 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
595 void Undo() raises (LockProtection);
596 /*! \brief Redo method
598 Redoes all actions of the last command.
600 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
602 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
605 void Redo() raises (LockProtection);
607 Returns True if at this moment there are any actions which can be canceled.
609 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
612 boolean GetAvailableUndos();
614 Returns True if at this moment there are any actions which can be redone.
616 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
619 boolean GetAvailableRedos();
621 Puts name attribute with the given string value to the given %SObject
623 \param theSO Existing SObject to set name attribute.
624 \param theValue The value to be set to the name attribute.
626 void SetName(in SObject theSO, in string theValue) raises (LockProtection);
629 Puts comment attribute with the given string value to the given %SObject
631 \param theSO Existing SObject to set comment attribute.
632 \param theValue The value to be set to the comment attribute.
634 void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
637 Puts IOR attribute with the given string value to the given %SObject
639 \param theSO Existing SObject to set IOR attribute.
640 \param theValue The value to be set to the IOR attribute.
642 void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
645 //==========================================================================
646 /*! \brief %Study Manager interface
648 The purpose of the Manager is to manipulate the %Studies. You will find in this
649 interface the methods to create, open,
650 close, and save a %Study. Since a %SALOME session is multi-document, you will
651 also find the methods allowing to navigate
652 through the collection of studies present in a session.
654 //==========================================================================
656 interface StudyManager
659 Determines whether the server has already been loaded or not.
663 /*! \brief Creation of a new study
665 Creates a new study with a definite name.
667 \param study_name String parameter defining the name of the study
669 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
672 Study NewStudy(in string study_name);
674 /*! \brief Open a study
676 Reads and activates the structure of the study %Objects.
677 \param aStudyUrl The path to the study
678 \warning This method doesn't activate the corba objects. Only a component can do it.
680 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
682 Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
684 /*! \brief Closing the study
688 void Close(in Study aStudy);
689 /*! \brief Saving the study in a HDF file (or files).
693 \param theMultiFile If this parameter is True the study will be saved in several files.
695 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
698 boolean Save(in Study aStudy, in boolean theMultiFile);
699 /*! \brief Saving a study in a ASCII file (or files).
701 Saves a study in an ASCII format file (or files).
702 \param theMultiFile If this parameter is True the study will be saved in several files.
704 boolean SaveASCII(in Study aStudy, in boolean theMultiFile);
705 /*! \brief Saving the study in a specified HDF file (or files).
707 Saves the study in a specified file (or files).
708 \param aUrl The path to the definite file in whcih the study will be saved
709 \param aStudy The study which will be saved
710 \param theMultiFile If this parameter is True the study will be saved in several files.
712 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
714 boolean SaveAs(in URL aUrl, // if the file already exists
716 in boolean theMultiFile); // overwrite (as option)
717 /*! \brief Saving the study in a specified ASCII file (or files).
719 Saves the study in a specified ASCII file (or files).
721 \param aUrl The path to the definite file in whcih the study will be saved
722 \param aStudy The study which will be saved
723 \param theMultiFile If this parameter is True the study will be saved in several files.
725 boolean SaveAsASCII(in URL aUrl, // if the file already exists
727 in boolean theMultiFile); // overwrite (as option)
730 /*! \brief List of open studies.
732 Gets the list of open studies
734 \return A list of open studies in the current session.
736 ListOfOpenStudies GetOpenStudies();
738 /*! \brief Getting a particular %Study picked by name
740 Activates a particular %Study
741 among the session collection picking it by name.
742 \param aStudyName The name of the study
744 Study GetStudyByName (in string aStudyName);
746 /*! \brief Getting a particular %Study picked by ID
748 Activates a particular %Study
749 among the session collection picking it by ID.
750 \param aStudyID The ID of the study
752 Study GetStudyByID (in short aStudyID);
754 // copy/paste methods
757 Returns True, if the given %SObject can be copied to the clipboard.
759 boolean CanCopy(in SObject theObject);
761 Returns True, if the given %SObject is copied to the clipboard.
762 \param theObject The %SObject which will be copied
764 boolean Copy(in SObject theObject);
766 Returns True, if the object from the clipboard can be pasted to the given %SObject.
767 \param theObject The %SObject stored in the clipboard.
769 boolean CanPaste(in SObject theObject);
771 Returns the %SObject in which the object from the clipboard was pasted to.
772 \param theObject The %SObject which will be pasted
773 \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
774 an object into a study, which is protected for modifications.
776 SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
778 /*! \brief Object conversion.
780 Converts an object into IOR.
783 string ConvertObjectToIOR(in Object theObject);
784 /*! \brief Object conversion.
786 Converts IOR into an object.
789 Object ConvertIORToObject(in string theIOR);
792 Private method, returns an implementation of this StudyManager.
793 \param theHostname is a hostname of the caller
794 \param thePID is a process ID of the caller
795 \param isLocal is set True if the StudyManager is launched locally with the caller
797 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
803 //==========================================================================
804 /*! \brief %SObject interface
806 The objects in the %study are built by the %StudyBuilder. The %SObject interface
807 provides methods for elementary inquiries, like getting an object %ID or its attribuites.
810 <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
811 in the tree-type data structure.
812 <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
813 ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
815 //==========================================================================
817 interface SObject : SALOME::GenericObj
819 /*! Name of the %SObject
821 attribute string Name; // equivalent to setName() & getName()
822 /*! Gets an object %ID
824 \return ID of the %SObject.
827 /*! Acquisition of the father %Component of the %SObject
829 \return The father %Component of the %SObject.
831 SComponent GetFatherComponent();
832 /*! Acquisition of the father %SObject of the %SObject
834 \return the father %SObject of the given %SObject.
837 /*! Gets the %tag of a %SObject
839 \return the %tag of a %SObject.
842 /*! Gets the depth of a %SObject
844 \return the depth of a %SObject.
847 /*! Looks for subobjects of a given %SObject.
849 \param atag Tag of the given %SObject
850 \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
853 boolean FindSubObject (in long atag, out SObject obj);
854 /*! Looks for attributes of a given %SObject
856 \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
857 \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
859 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
861 boolean FindAttribute(out GenericAttribute anAttribute,
862 in string aTypeOfAttribute);
863 /*! Looks for a %SObject which the given %SObject refers to.
865 \return The object which the given %SObject refers to as well as True if it finds
868 boolean ReferencedObject(out SObject obj); // A REVOIR
869 /*! Gets all attributes of a given %SObject
871 \return The list of all attributes of the given %SObject.
873 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
876 ListOfAttributes GetAllAttributes();
877 /*! Gets the study of a given %SObject.
879 /return The study containing the given %SObject.
883 /*! Gets the CORBA object by its own IOR attribute.
884 Returns nil, if can't.
886 /return The CORBA object of the %SObject.
891 Returns the name attribute value of this SObject.
892 Returns empty string if there is no name attribute.
897 Returns the comment attribute value of this SObject.
898 Returns empty string if there is no comment attribute.
903 Returns the IOR attribute value of this SObject.
904 Returns empty string if there is no IOR attribute.
909 Private method, returns an implementation of this SObject.
910 \param theHostname is a hostname of the caller
911 \param thePID is a process ID of the caller
912 \param isLocal is set True if the SObject is launched locally with the caller
914 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
918 //==========================================================================
919 /*! \brief %Generic attribute interface
921 %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
923 //==========================================================================
924 interface GenericAttribute : SALOME::GenericObj
926 /*! \brief Exception locking all changes
928 This exception locks all modifications in attributes.
930 exception LockProtection {};
931 /*! \brief Method CheckLocked
933 Checks whether the %Study is protected for modifications.
935 \note <BR>This exception is raised only outside a transaction.
937 void CheckLocked() raises (LockProtection);
941 string GetClassType();
943 SObject GetSObject();
946 Private method, returns an implementation of this GenericAttribute.
947 \param theHostname is a hostname of the caller
948 \param thePID is a process ID of the caller
949 \param isLocal is set True if the GenericAttribute is launched locally with the caller
951 long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
956 //==========================================================================
957 /*! \brief %SComponent interface
959 The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
960 The %SComponent interface is a specialization of the %SObject interface.
961 It inherits the most of its methods from the %SObject interface.
963 //==========================================================================
964 interface SComponent : SObject
966 /*! Gets the data type of the given %SComponent
968 \return The data type of this %SComponent.
970 string ComponentDataType();
971 /*! Gets the IOR of the given component
973 \return True (if there is an instance of the given component) and its IOR.
975 boolean ComponentIOR (out ID theID); //returns True if there is an instance
976 //In this case ID identifies this one
980 //==========================================================================
981 /*! \brief %SComponentIterator interface
983 This interface contains the methods allowing to iterate over all components in the list.
984 The search is started from the first %SComponent in the list.
986 //==========================================================================
987 interface SComponentIterator : SALOME::GenericObj
990 Activates the %SComponentIterator.
995 \return True if there is one more %SComponent in the list.
999 Moves the iterator to the next %SComponent in the list.
1003 Returns the %SComponent corresponding to the current %SComponent found by the iterator.
1005 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1011 //==========================================================================
1012 /*! \brief %ChildIterator interface
1014 This interface contains methods which allow to iterate over all child
1017 //==========================================================================
1018 interface ChildIterator : SALOME::GenericObj
1022 Activates the %ChildIterator.
1027 Activates the %ChildIterator for all child levels.
1029 \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
1031 void InitEx(in boolean allLevels);
1034 \return True if there is one more %ChildIterator in the list.
1038 Passes the iterator to the next level.
1042 Returns the %SObject corresponding to the current object found by the iterator.
1047 //==========================================================================
1048 //==========================================================================
1049 /*! \brief Interface of the %UseCaseIterator.
1051 This interface contains a set of methods used for iteration over the objects in the use case.
1053 interface UseCaseIterator : SALOME::GenericObj
1056 Activates the %UseCaseIterator.
1057 \param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
1059 void Init(in boolean allLevels);
1062 \return True if the %UseCaseIterator finds one more object.
1066 Passes the iterator to the next object.
1070 Returns the %SObject corresponding to the current object found by the Iterator.
1075 //==========================================================================
1076 //==========================================================================
1077 /*! \brief Interface of the %UseCaseBuilder
1079 Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1080 The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1082 interface UseCaseBuilder : SALOME::GenericObj
1085 Adds to the use case an object as a child of the current object of the use case.
1087 \param theObject The added %SObject.
1088 \return True if this %SObject has been added in the use case.
1090 boolean Append(in SObject theObject);
1092 Removes an object from the use case.
1094 \param theObject The deleted %SObject
1095 \return True if this %SObject has been deleted from the use case.
1097 boolean Remove(in SObject theObject);
1099 Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1101 boolean AppendTo(in SObject theFather, in SObject theObject);
1103 Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1105 boolean InsertBefore(in SObject theFirst, in SObject theNext);
1107 Sets the current object of the use case.
1109 boolean SetCurrentObject(in SObject theObject);
1111 Makes the root object to be the current object of the use case.
1113 boolean SetRootCurrent();
1115 Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1117 boolean HasChildren(in SObject theObject);
1119 Sets the name of the use case.
1121 boolean SetName(in string theName);
1123 Gets the name of the use case.
1127 Returns True if the given object <VAR>theObject</VAR> represents a use case.
1129 boolean IsUseCase(in SObject theObject);
1131 Gets the current object of the use case.
1133 SObject GetCurrentObject();
1135 Creates a new use case in the use case browser.
1137 SObject AddUseCase(in string theName);
1139 Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1141 UseCaseIterator GetUseCaseIterator(in SObject theObject);
1143 //==========================================================================
1144 /*! \brief %Driver interface
1146 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
1147 can be called by any component and which provide the following functionality:
1149 <li> publishing in the study of the objects created by a definite component
1150 <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.
1151 <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
1152 <li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
1156 //==========================================================================
1160 /*! \brief Saving the data produced by a definite component.
1162 This method is called by the StudyManager when saving a study.
1163 \param theComponent %SComponent corresponding to this Component
1164 \param theURL The path to the file in which the data will be saved.
1165 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1166 \return A byte stream TMPFile that contains all saved data
1168 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1173 TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1175 /*! \brief Saving the data in ASCII format produced by a definite component.
1177 This method is called by the StudyManager when saving a study in ASCII format.
1178 \param theComponent %SComponent corresponding to this Component
1179 \param theURL The path to the file in which the data will be saved.
1180 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1181 \return A byte stream TMPFile that will contain all saved data
1183 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1186 TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1188 /*! \brief Loading the data.
1190 This method is called by the StudyManager when opening a study.
1191 \param theComponent %SComponent corresponding to this Component
1192 \param theStream The file which contains all data saved by the component on Save method
1193 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1197 boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1199 /*! \brief Loading the data from files in ASCII format.
1201 This method is called by the StudyManager when opening a study.
1202 \param theComponent %SComponent corresponding to this Component
1203 \param theStream The file which contains all data saved by the component on Save method
1204 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1208 boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1210 /*! \brief Closing of the study
1212 This method Close is called by the StudyManager when closing a study.
1213 \param aSComponent The according %SComponent
1216 void Close (in SComponent aSComponent);
1217 //void Close ( in string aIORSComponent);
1219 /*! Gets the type of the data
1221 \return The type of data produced by the Component in the study.
1224 string ComponentDataType();
1226 // Driver Transient -> persistent called for each object in study
1228 Transforms IOR of a given %SObject into PersistentID. It is called for each
1229 object in the %study.
1230 \note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
1231 study is saved these references are transformed into persintent IDs.
1233 \param theSObject The given %SObject.
1234 \param IORString The IOR of the given %SObject.
1235 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1236 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1238 \return The persistent ID of the given %SObject
1241 string IORToLocalPersistentID (in SObject theSObject,
1242 in string IORString,
1243 in boolean isMultiFile,
1244 in boolean isASCII);
1246 Transforms PersistentID into IOR of the object. It is called for each
1247 object in the %study.
1249 \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
1250 study is open, these references are transformed into persintent IORs.
1252 \param theSObject The given %SObject.
1253 \param IORString The IOR of the given %SObject.
1254 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1255 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1257 \return The IOR of the given %SObject
1260 string LocalPersistentIDToIOR (in SObject theSObject,
1261 in string aLocalPersistentID,
1262 in boolean isMultiFile,
1264 raises (SALOME::SALOME_Exception);
1266 // Publishing in the study
1267 /*! Publishing in the study
1269 \return True if the given %Component can publish a definite object with a given IOR in the %study.
1270 \param theIOR The IOR of a definite object
1272 boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1273 /*! \brief Publishing in the study
1275 Publishes the given object in the %study, using the algorithm of this component.
1276 \param theStudy The %study in which the object is published
1277 \param theSObject If this parameter is null the object is published for the first time. Otherwise
1278 this parameter should contain a reference to the object published earlier
1279 \param theObject The object which is published
1280 \param theName The name of the published object. If this parameter is empty, the name is generated
1281 automatically by the component.
1283 \return The published %SObject.
1285 SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
1287 // copy/paste methods
1290 Returns True, if the given %SObject can be copied to the clipboard.
1292 \param theObject The given %SObject which should be copied.
1294 boolean CanCopy(in SObject theObject);
1296 Returns the object %ID and the %TMPFile of the object from the given %SObject.
1298 TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1300 Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1302 boolean CanPaste(in string theComponentName, in long theObjectID);
1304 Returns the %SObject of the pasted object.
1306 SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);