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"
41 This package contains the interfaces used for creation, managment
42 and modification of the %Study
47 Name of the file in which the %Study is saved.
52 /*! Main identifier of an object in %SALOME application
56 /*! While saving the data, IOR is transformed into persistent reference
58 typedef string PersistentReference;
60 /*! IOR of the study in %SALOME application
62 typedef string SalomeReference;
64 /*! List of the names of studies which are currently open in this %SALOME session.
65 Since %SALOME is a multi-study application, it allows to open a lot of studies
66 during each working session.
68 typedef sequence<string> ListOfOpenStudies;
69 /*! List of file names
71 typedef sequence<string> ListOfFileNames;
72 /*! List of modification dates of a study
74 typedef sequence<string> ListOfDates ;
75 /*! An unbounded sequence of strings
77 typedef sequence<string> ListOfStrings ;
78 /*! A byte stream which is used for binary data transfer between different components
80 typedef sequence<octet> TMPFile;
82 // Reference to other objects is treated with function AddReference
83 // and ReferencedObject
84 // All other type of attributes defined in AttributeType enum are
85 // treated with AddAdttribute and GetAttribute
86 // The difference is made because Reference attribute don't contain
87 // strings but reference to ID of other objects
89 interface GenericAttribute;
91 interface StudyManager;
92 interface StudyBuilder;
95 interface SComponentIterator;
96 interface ChildIterator;
98 interface AttributeStudyProperties;
99 interface UseCaseIterator;
100 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);
372 //==========================================================================
373 /*! \brief %Study Builder Interface
375 The purpose of the Builder is to add and/or remove objects and attributes.
376 A %StudyBuilder is linked to a %Study. A
377 command management is provided for the undo/redo functionalities.
379 <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
380 item's position in the tree-type structure of the browser. In general it has the following
381 form: <TT>0:2:1:1</TT>
383 //==========================================================================
385 interface StudyBuilder
387 /*! \brief %LockProtection Exception
389 This exception is raised while attempting to modify a locked %study.
391 exception LockProtection {};
392 /*! \brief Creation of a new %SComponent.
394 Creates a new %SComponent
395 \param ComponentDataType Data type of the %SComponent which will be created.
397 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
400 SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
401 /*! \brief Definition of the instance to the %SComponent
403 Defines the instance to the %SComponent.
405 void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
406 /*! \brief Deletion of a %SComponent
408 Removes a %SComponent.
410 void RemoveComponent(in SComponent aComponent) raises(LockProtection);
412 /*! \brief Creation of a new %SObject
414 Creates a new %SObject under a definite father %SObject.
416 \param theFatherObject The father %SObject under which this one should be created.
419 <BR><VAR>See also <A href=exemple/Example18.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
423 SObject NewObject (in SObject theFatherObject) raises(LockProtection);
425 /*! \brief Creation of a new %SObject with a definite %tag
427 Creates a new %SObject with a definite %tag.
429 \param atag Long value corresponding to the tag of the new %SObject.
433 SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
434 /*! \brief Deletion of the %SObject
436 Removes a %SObject from the %StudyBuilder.
438 \param anObject The %SObject to be deleted.
440 void RemoveObject (in SObject anObject) raises(LockProtection);
441 /*! \brief Deletion of the %SObject with all his child objects.
443 Removes the %SObject with all his child objects.
445 \param anObject The %SObject to be deleted with all child objects.
447 void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
452 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
455 void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
459 \param sco %SObject to be loaded.
461 void Load (in SObject sco);
463 /*! \brief Looking for or creating an attribute assigned to the %SObject
465 Allows to find or create an attribute of a specific type which is assigned to the object.
466 \param anObject The %SObject corresponding to the attribute which is looked for.
467 \param aTypeOfAttribute Type of the attribute.
469 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
472 GenericAttribute FindOrCreateAttribute(in SObject anObject,
473 in string aTypeOfAttribute) raises(LockProtection);
475 /*! \brief Looking for an attribute assigned to a %SObject
477 Allows to find 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.
480 \param anAttribute Where the attribute is placed if it's found.
481 \return True if it finds an attribute.
484 boolean FindAttribute(in SObject anObject,
485 out GenericAttribute anAttribute,
486 in string aTypeOfAttribute);
487 /*! \brief Deleting the attribute assigned to the %SObject
489 Removes the attribute of a specific type which is assigned to the object.
490 \param anObject The %SObject corresponding to the attribute.
491 \param aTypeOfAttribute Type of the attribute.
493 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
495 void RemoveAttribute(in SObject anObject,
496 in string aTypeOfAttribute) raises(LockProtection);
498 Adds a reference between %anObject and %theReferencedObject.
499 \param anObject The %SObject which will get a reference
500 \param theReferencedObject The %SObject having a reference
503 void Addreference(in SObject anObject,
504 in SObject theReferencedObject) ;
507 Removes a reference from %anObject to another object.
508 \param anObject The %SObject which contains a reference
511 void RemoveReference(in SObject anObject) ;
514 Adds a directory in the %Study.
515 \param theName String parameter defining the name of the directory.
517 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
520 void AddDirectory(in string theName) raises(LockProtection);
522 /*! \brief Identification of the %SObject's substructure.
524 Identification of the %SObject's substructure by GUID.
527 \param anObject The %SObject which will be identified
528 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
531 void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
533 Searches for a definite %SObject with a definite GUID and returns True if it finds it.
535 \param anObject A definite %SObject which will be identified
536 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
538 boolean IsGUID(in SObject anObject, in string theGUID);
540 /*! \brief Creation of a new command
542 Creates a new command which can contain several different actions.
544 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
547 void NewCommand(); // command management
548 /*! \brief Execution of the command
550 Commits all actions declared within this command.
552 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
554 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
557 void CommitCommand() raises(LockProtection); // command management
559 Returns True if at this moment there is a command under execution.
561 boolean HasOpenCommand();
562 /*! \brief Cancelation of the command
564 Cancels all actions declared within the command.
566 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
568 void AbortCommand(); // command management
571 The number of actions which can be undone
573 attribute long UndoLimit;
574 /*! \brief Undo method
576 Cancels all actions of the last command.
578 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
580 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
583 void Undo() raises (LockProtection);
584 /*! \brief Redo method
586 Redoes all actions of the last 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 Redo() raises (LockProtection);
595 Returns True if at this moment there are any actions which can be canceled.
597 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
600 boolean GetAvailableUndos();
602 Returns True if at this moment there are any actions which can be redone.
604 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
607 boolean GetAvailableRedos();
609 This method is called when adding an object into study.
610 It sets the callback for addition of the given %SObject.
611 \param theCallback New assigned callback.
612 \return The previous callback.
614 Callback SetOnAddSObject(in Callback theCallback);
616 This method is called when adding an object into study.
617 It sets the callback for removal of the given %SObject.
619 \return The previous callback.
620 \param theCallback New assigned callback.
622 Callback SetOnRemoveSObject(in Callback theCallback);
625 Puts name attribute with the given string value to the given %SObject
627 \param theSO Existing SObject to set name attribute.
628 \param theValue The value to be set to the name attribute.
630 void SetName(in SObject theSO, in string theValue) raises (LockProtection);
633 Puts comment attribute with the given string value to the given %SObject
635 \param theSO Existing SObject to set comment attribute.
636 \param theValue The value to be set to the comment attribute.
638 void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
641 Puts IOR attribute with the given string value to the given %SObject
643 \param theSO Existing SObject to set IOR attribute.
644 \param theValue The value to be set to the IOR attribute.
646 void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
649 //==========================================================================
650 /*! \brief %Study Manager interface
652 The purpose of the Manager is to manipulate the %Studies. You will find in this
653 interface the methods to create, open,
654 close, and save a %Study. Since a %SALOME session is multi-document, you will
655 also find the methods allowing to navigate
656 through the collection of studies present in a session.
658 //==========================================================================
660 interface StudyManager
663 Determines whether the server has already been loaded or not.
667 /*! \brief Creation of a new study
669 Creates a new study with a definite name.
671 \param study_name String parameter defining the name of the study
673 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
676 Study NewStudy(in string study_name);
678 /*! \brief Open a study
680 Reads and activates the structure of the study %Objects.
681 \param aStudyUrl The path to the study
682 \warning This method doesn't activate the corba objects. Only a component can do it.
684 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
686 Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
688 /*! \brief Closing the study
692 void Close(in Study aStudy);
693 /*! \brief Saving the study in a HDF file (or files).
697 \param theMultiFile If this parameter is True the study will be saved in several files.
699 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
702 void Save(in Study aStudy, in boolean theMultiFile);
703 /*! \brief Saving a study in a ASCII file (or files).
705 Saves a study in an ASCII format file (or files).
706 \param theMultiFile If this parameter is True the study will be saved in several files.
708 void SaveASCII(in Study aStudy, in boolean theMultiFile);
709 /*! \brief Saving the study in a specified HDF file (or files).
711 Saves the study in a specified file (or files).
712 \param aUrl The path to the definite file in whcih the study will be saved
713 \param aStudy The study which will be saved
714 \param theMultiFile If this parameter is True the study will be saved in several files.
716 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
718 void SaveAs(in URL aUrl, // if the file already exists
720 in boolean theMultiFile); // overwrite (as option)
721 /*! \brief Saving the study in a specified ASCII file (or files).
723 Saves the study in a specified ASCII file (or files).
725 \param aUrl The path to the definite file in whcih the study will be saved
726 \param aStudy The study which will be saved
727 \param theMultiFile If this parameter is True the study will be saved in several files.
729 void SaveAsASCII(in URL aUrl, // if the file already exists
731 in boolean theMultiFile); // overwrite (as option)
734 /*! \brief List of open studies.
736 Gets the list of open studies
738 \return A list of open studies in the current session.
740 ListOfOpenStudies GetOpenStudies();
742 /*! \brief Getting a particular %Study picked by name
744 Activates a particular %Study
745 among the session collection picking it by name.
746 \param aStudyName The name of the study
748 Study GetStudyByName (in string aStudyName);
750 /*! \brief Getting a particular %Study picked by ID
752 Activates a particular %Study
753 among the session collection picking it by ID.
754 \param aStudyID The ID of the study
756 Study GetStudyByID (in short aStudyID);
758 // copy/paste methods
761 Returns True, if the given %SObject can be copied to the clipboard.
763 boolean CanCopy(in SObject theObject);
765 Returns True, if the given %SObject is copied to the clipboard.
766 \param theObject The %SObject which will be copied
768 boolean Copy(in SObject theObject);
770 Returns True, if the object from the clipboard can be pasted to the given %SObject.
771 \param theObject The %SObject stored in the clipboard.
773 boolean CanPaste(in SObject theObject);
775 Returns the %SObject in which the object from the clipboard was pasted to.
776 \param theObject The %SObject which will be pasted
777 \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
778 an object into a study, which is protected for modifications.
780 SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
784 //==========================================================================
785 /*! \brief %SObject interface
787 The objects in the %study are built by the %StudyBuilder. The %SObject interface
788 provides methods for elementary inquiries, like getting an object %ID or its attribuites.
791 <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
792 in the tree-type data structure.
793 <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
794 ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
796 //==========================================================================
800 /*! Name of the %SObject
802 attribute string Name; // equivalent to setName() & getName()
803 /*! Gets an object %ID
805 \return ID of the %SObject.
808 /*! Acquisition of the father %Component of the %SObject
810 \return The father %Component of the %SObject.
812 SComponent GetFatherComponent();
813 /*! Acquisition of the father %SObject of the %SObject
815 \return the father %SObject of the given %SObject.
818 /*! Gets the %tag of a %SObject
820 \return the %tag of a %SObject.
823 /*! Looks for subobjects of a given %SObject.
825 \param atag Tag of the given %SObject
826 \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
829 boolean FindSubObject (in long atag, out SObject obj);
830 /*! Looks for attributes of a given %SObject
832 \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
833 \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
835 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
837 boolean FindAttribute(out GenericAttribute anAttribute,
838 in string aTypeOfAttribute);
839 /*! Looks for a %SObject which the given %SObject refers to.
841 \return The object which the given %SObject refers to as well as True if it finds
844 boolean ReferencedObject(out SObject obj); // A REVOIR
845 /*! Gets all attributes of a given %SObject
847 \return The list of all attributes of the given %SObject.
849 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
852 ListOfAttributes GetAllAttributes();
853 /*! Gets the study of a given %SObject.
855 /return The study containing the given %SObject.
859 /*! Gets the CORBA object by its own IOR attribute.
860 Returns nil, if can't.
862 /return The CORBA object of the %SObject.
867 Returns the name attribute value of this SObject.
868 Returns empty string if there is no name attribute.
873 Returns the comment attribute value of this SObject.
874 Returns empty string if there is no comment attribute.
879 Returns the IOR attribute value of this SObject.
880 Returns empty string if there is no IOR attribute.
886 //==========================================================================
887 /*! \brief %Generic attribute interface
889 %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
891 //==========================================================================
892 interface GenericAttribute
894 /*! \brief Exception locking all changes
896 This exception locks all modifications in attributes.
898 exception LockProtection {};
899 /*! \brief Method CheckLocked
901 Checks whether the %Study is protected for modifications.
903 \note <BR>This exception is raised only outside a transaction.
905 void CheckLocked() raises (LockProtection);
909 void Restore(in string theData);
913 SObject GetSObject();
918 //==========================================================================
919 /*! \brief %SComponent interface
921 The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
922 The %SComponent interface is a specialization of the %SObject interface.
923 It inherits the most of its methods from the %SObject interface.
925 //==========================================================================
926 interface SComponent : SObject
928 /*! Gets the data type of the given %SComponent
930 \return The data type of this %SComponent.
932 string ComponentDataType();
933 /*! Gets the IOR of the given component
935 \return True (if there is an instance of the given component) and its IOR.
937 boolean ComponentIOR (out ID theID); //returns True if there is an instance
938 //In this case ID identifies this one
942 //==========================================================================
943 /*! \brief %SComponentIterator interface
945 This interface contains the methods allowing to iterate over all components in the list.
946 The search is started from the first %SComponent in the list.
948 //==========================================================================
949 interface SComponentIterator
952 Activates the %SComponentIterator.
957 \return True if there is one more %SComponent in the list.
961 Moves the iterator to the next %SComponent in the list.
965 Returns the %SComponent corresponding to the current %SComponent found by the iterator.
967 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
973 //==========================================================================
974 /*! \brief %ChildIterator interface
976 This interface contains methods which allow to iterate over all child
979 //==========================================================================
980 interface ChildIterator
984 Activates the %ChildIterator.
989 Activates the %ChildIterator for all child levels.
991 \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
993 void InitEx(in boolean allLevels);
996 \return True if there is one more %ChildIterator in the list.
1000 Passes the iterator to the next level.
1004 Returns the %SObject corresponding to the current object found by the iterator.
1009 //==========================================================================
1010 //==========================================================================
1011 /*! \brief Interface of the %UseCaseIterator.
1013 This interface contains a set of methods used for iteration over the objects in the use case.
1015 interface UseCaseIterator
1018 Activates the %UseCaseIterator.
1019 \param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
1021 void Init(in boolean allLevels);
1024 \return True if the %UseCaseIterator finds one more object.
1028 Passes the iterator to the next object.
1032 Returns the %SObject corresponding to the current object found by the Iterator.
1037 //==========================================================================
1038 //==========================================================================
1039 /*! \brief Interface of the %UseCaseBuilder
1041 Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1042 The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1044 interface UseCaseBuilder
1047 Adds to the use case an object as a child of the current object of the use case.
1049 \param theObject The added %SObject.
1050 \return True if this %SObject has been added in the use case.
1052 boolean Append(in SObject theObject);
1054 Removes an object from the use case.
1056 \param theObject The deleted %SObject
1057 \return True if this %SObject has been deleted from the use case.
1059 boolean Remove(in SObject theObject);
1061 Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1063 boolean AppendTo(in SObject theFather, in SObject theObject);
1065 Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1067 boolean InsertBefore(in SObject theFirst, in SObject theNext);
1069 Sets the current object of the use case.
1071 boolean SetCurrentObject(in SObject theObject);
1073 Makes the root object to be the current object of the use case.
1075 boolean SetRootCurrent();
1077 Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1079 boolean HasChildren(in SObject theObject);
1081 Sets the name of the use case.
1083 boolean SetName(in string theName);
1085 Gets the name of the use case.
1089 Returns True if the given object <VAR>theObject</VAR> represents a use case.
1091 boolean IsUseCase(in SObject theObject);
1093 Gets the current object of the use case.
1095 SObject GetCurrentObject();
1097 Creates a new use case in the use case browser.
1099 SObject AddUseCase(in string theName);
1101 Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1103 UseCaseIterator GetUseCaseIterator(in SObject theObject);
1105 //==========================================================================
1106 //==========================================================================
1107 /*! \brief The callback interface
1109 The %StudyBuilder can be created with the method <VAR>NewBuilder</VAR>. While invocation of this method a new object of the class <VAR>Callback</VAR> is created
1110 and this object is assigned to the newly created Builder as callback which should be called when adding and removing of the ojects.
1115 Invokes the corresponding method <VAR>Append</VAR> of the %UseCaseBuilder.
1117 void OnAddSObject(in SObject theObject);
1119 Invokes the corresponding method <VAR>Remove</VAR> of the %UseCaseBuilder.
1121 void OnRemoveSObject(in SObject theObject);
1124 //==========================================================================
1125 /*! \brief %Driver interface
1127 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
1128 can be called by any component and which provide the following functionality:
1130 <li> publishing in the study of the objects created by a definite component
1131 <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.
1132 <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
1133 <li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
1137 //==========================================================================
1141 /*! \brief Saving the data produced by a definite component.
1143 This method is called by the StudyManager when saving a study.
1144 \param theComponent %SComponent corresponding to this Component
1145 \param theURL The path to the file in which the data will be saved.
1146 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1147 \return A byte stream TMPFile that contains all saved data
1149 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1154 TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1156 /*! \brief Saving the data in ASCII format produced by a definite component.
1158 This method is called by the StudyManager when saving a study in ASCII format.
1159 \param theComponent %SComponent corresponding to this Component
1160 \param theURL The path to the file in which the data will be saved.
1161 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1162 \return A byte stream TMPFile that will contain all saved data
1164 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1167 TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1169 /*! \brief Loading the data.
1171 This method is called by the StudyManager when opening a study.
1172 \param theComponent %SComponent corresponding to this Component
1173 \param theStream The file which contains all data saved by the component on Save method
1174 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1178 boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1180 /*! \brief Loading the data from files in ASCII format.
1182 This method is called by the StudyManager when opening a study.
1183 \param theComponent %SComponent corresponding to this Component
1184 \param theStream The file which contains all data saved by the component on Save method
1185 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1189 boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1191 /*! \brief Closing of the study
1193 This method Close is called by the StudyManager when closing a study.
1194 \param aSComponent The according %SComponent
1197 void Close (in SComponent aSComponent);
1198 //void Close ( in string aIORSComponent);
1200 /*! Gets the type of the data
1202 \return The type of data produced by the Component in the study.
1205 string ComponentDataType();
1207 // Driver Transient -> persistent called for each object in study
1209 Transforms IOR of a given %SObject into PersistentID. It is called for each
1210 object in the %study.
1211 \note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
1212 study is saved these references are transformed into persintent IDs.
1214 \param theSObject The given %SObject.
1215 \param IORString The IOR of the given %SObject.
1216 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1217 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1219 \return The persistent ID of the given %SObject
1222 string IORToLocalPersistentID (in SObject theSObject,
1223 in string IORString,
1224 in boolean isMultiFile,
1225 in boolean isASCII);
1227 Transforms PersistentID into IOR of the object. It is called for each
1228 object in the %study.
1230 \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
1231 study is open, these references are transformed into persintent IORs.
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 IOR of the given %SObject
1241 string LocalPersistentIDToIOR (in SObject theSObject,
1242 in string aLocalPersistentID,
1243 in boolean isMultiFile,
1245 raises (SALOME::SALOME_Exception);
1247 // Publishing in the study
1248 /*! Publishing in the study
1250 \return True if the given %Component can publish a definite object with a given IOR in the %study.
1251 \param theIOR The IOR of a definite object
1253 boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1254 /*! \brief Publishing in the study
1256 Publishes the given object in the %study, using the algorithm of this component.
1257 \param theStudy The %study in which the object is published
1258 \param theSObject If this parameter is null the object is published for the first time. Otherwise
1259 this parameter should contain a reference to the object published earlier
1260 \param theObject The object which is published
1261 \param theName The name of the published object. If this parameter is empty, the name is generated
1262 automatically by the component.
1264 \return The published %SObject.
1266 SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
1268 // copy/paste methods
1271 Returns True, if the given %SObject can be copied to the clipboard.
1273 \param theObject The given %SObject which should be copied.
1275 boolean CanCopy(in SObject theObject);
1277 Returns the object %ID and the %TMPFile of the object from the given %SObject.
1279 TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1281 Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1283 boolean CanPaste(in string theComponentName, in long theObjectID);
1285 Returns the %SObject of the pasted object.
1287 SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);