1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SALOMEDS.idl
24 // Author : Yves FRICAUD
26 /*! \file SALOMEDS.idl \brief This file contains a set of interfaces used for creation, management
27 and modification of the %Study
30 #ifndef _SALOMEDS_IDL_
31 #define _SALOMEDS_IDL_
33 #include "SALOME_Exception.idl"
34 #include "SALOME_GenericObj.idl"
37 This package contains the interfaces used for creation, management
38 and modification of the %Study
42 /*! \brief Name of the file in which the %Study is saved.
44 typedef string URLPath;
46 /*! \brief Main identifier of an object in %SALOME application
50 /*! \brief While saving the data, IOR is transformed into persistent reference
52 typedef string PersistentReference;
54 /*! \brief IOR of the study in %SALOME application
56 typedef string SalomeReference;
58 //! List of modification dates of a study
59 typedef sequence<string> ListOfDates ;
60 //! An unbounded sequence of strings
61 typedef sequence<string> ListOfStrings ;
62 //! An unbounded sequence of sequence of strings
63 typedef sequence<ListOfStrings> ListOfListOfStrings ;
64 //! A byte stream which is used for binary data transfer between different components
65 typedef sequence<octet> TMPFile;
67 // Reference to other objects is treated with function AddReference
68 // and ReferencedObject
69 // All other type of attributes defined in AttributeType enum are
70 // treated with AddAdttribute and GetAttribute
71 // The difference is made because Reference attribute don't contain
72 // strings but reference to ID of other objects
74 interface GenericAttribute;
76 interface StudyBuilder;
79 interface SComponentIterator;
80 interface ChildIterator;
82 interface AttributeStudyProperties;
83 interface AttributeParameter;
84 interface UseCaseIterator;
85 interface UseCaseBuilder;
89 oneway void notifyObserverID(in string theID, in long event);
93 //! List of attributes of %SObjects
94 typedef sequence<GenericAttribute> ListOfAttributes;
96 //! Exception indicating that this feature hasn't been implemented in %SALOME application.
97 exception NotImplemented {};
99 //==========================================================================
100 /*! \brief %Study Builder Interface
102 The purpose of the Builder is to add and/or remove objects and attributes.
103 A %StudyBuilder is linked to a %Study. A
104 command management is provided for the undo/redo functionalities.
106 <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
107 item's position in the tree-type structure of the browser. In general it has the following
108 form: <TT>0:2:1:1</TT>
110 //==========================================================================
112 interface StudyBuilder
114 /*! \brief %LockProtection Exception
116 This exception is raised while attempting to modify a locked %study.
118 exception LockProtection {};
119 /*! \brief Creation of a new %SComponent.
121 Creates a new %SComponent
122 \param ComponentDataType Data type of the %SComponent which will be created.
124 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
127 SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
128 /*! \brief Definition of the instance to the %SComponent
130 Defines the instance to the %SComponent.
132 void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
134 /*! \brief Deletion of a %SComponent
136 Removes a %SComponent.
138 void RemoveComponent(in SComponent aComponent) raises(LockProtection);
140 /*! \brief Creation of a new %SObject
142 Creates a new %SObject under a definite father %SObject.
144 \param theFatherObject The father %SObject under which this one should be created.
147 <em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
151 SObject NewObject (in SObject theFatherObject) raises(LockProtection);
153 /*! \brief Creation of a new %SObject with a definite %tag
155 Creates a new %SObject with a definite %tag.
157 \param atag Long value corresponding to the tag of the new %SObject.
161 SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
162 /*! \brief Deletion of the %SObject
164 Removes a %SObject from the %StudyBuilder.
166 \param anObject The %SObject to be deleted.
168 void RemoveObject (in SObject anObject) raises(LockProtection);
169 /*! \brief Deletion of the %SObject with all his child objects.
171 Removes the %SObject with all his child objects.
173 \param anObject The %SObject to be deleted with all child objects.
175 void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
180 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
183 void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
187 \param sco %SObject to be loaded.
189 void Load (in SObject sco);
191 /*! \brief Looking for or creating an attribute assigned to the %SObject
193 Allows to find or create an attribute of a specific type which is assigned to the object.
194 \param anObject The %SObject corresponding to the attribute which is looked for.
195 \param aTypeOfAttribute Type of the attribute.
197 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
200 GenericAttribute FindOrCreateAttribute(in SObject anObject,
201 in string aTypeOfAttribute) raises(LockProtection);
203 /*! \brief Looking for an attribute assigned to a %SObject
205 Allows to find an attribute of a specific type which is assigned to the object.
206 \param anObject The %SObject corresponding to the attribute which is looked for.
207 \param aTypeOfAttribute Type of the attribute.
208 \param anAttribute Where the attribute is placed if it's found.
209 \return True if it finds an attribute.
212 boolean FindAttribute(in SObject anObject,
213 out GenericAttribute anAttribute,
214 in string aTypeOfAttribute);
215 /*! \brief Deleting the attribute assigned to the %SObject
217 Removes the attribute of a specific type which is assigned to the object.
218 \param anObject The %SObject corresponding to the attribute.
219 \param aTypeOfAttribute Type of the attribute.
221 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
223 void RemoveAttribute(in SObject anObject,
224 in string aTypeOfAttribute) raises(LockProtection);
226 Adds a reference between %anObject and %theReferencedObject.
227 \param anObject The %SObject which will get a reference
228 \param theReferencedObject The %SObject having a reference
231 void Addreference(in SObject anObject,
232 in SObject theReferencedObject) ;
235 Removes a reference from %anObject to another object.
236 \param anObject The %SObject which contains a reference
239 void RemoveReference(in SObject anObject) ;
241 /*! \brief Identification of the %SObject's substructure.
243 Identification of the %SObject's substructure by GUID.
246 \param anObject The %SObject which will be identified
247 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
250 void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
252 Searches for a definite %SObject with a definite GUID and returns True if it finds it.
254 \param anObject A definite %SObject which will be identified
255 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
257 boolean IsGUID(in SObject anObject, in string theGUID);
259 /*! \brief Creation of a new command
261 Creates a new command which can contain several different actions.
263 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
266 void NewCommand(); // command management
267 /*! \brief Execution of the command
269 Commits all actions declared within this command.
271 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
273 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
276 void CommitCommand() raises(LockProtection); // command management
278 Returns True if at this moment there is a command under execution.
280 boolean HasOpenCommand();
281 /*! \brief Cancelation of the command
283 Cancels all actions declared within the command.
285 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
287 void AbortCommand(); // command management
290 The number of actions which can be undone
292 attribute long UndoLimit;
293 /*! \brief Undo method
295 Cancels all actions of the last command.
297 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
299 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
302 void Undo() raises (LockProtection);
303 /*! \brief Redo method
305 Redoes all actions of the last command.
307 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
309 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
312 void Redo() raises (LockProtection);
314 Returns True if at this moment there are any actions which can be canceled.
316 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
319 boolean GetAvailableUndos();
321 Returns True if at this moment there are any actions which can be redone.
323 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
326 boolean GetAvailableRedos();
328 Puts name attribute with the given string value to the given %SObject
330 \param theSO Existing SObject to set name attribute.
331 \param theValue The value to be set to the name attribute.
333 void SetName(in SObject theSO, in string theValue) raises (LockProtection);
336 Puts comment attribute with the given string value to the given %SObject
338 \param theSO Existing SObject to set comment attribute.
339 \param theValue The value to be set to the comment attribute.
341 void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
344 Puts IOR attribute with the given string value to the given %SObject
346 \param theSO Existing SObject to set IOR attribute.
347 \param theValue The value to be set to the IOR attribute.
349 void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
352 //===========================================================================
353 /*! \brief %Study Interface
355 The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
356 Most of the %Study operations are handled by the StudyBuilder.
357 What is left in the %Study interface are elementary inquiries.
358 (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
359 and set methods.) A %Study is explored by a set of tools, mainly iterators
360 , which are described further. Nevertheless, the %Study
361 interface allows the search of an object by name or by ID.
363 <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
364 In general it's a string of names of directories divided by a slash '/'.
365 <BR><VAR>The Context</VAR> is the current directory of an object.</P>
371 //! Invalid study reference
372 exception StudyInvalidReference {};
373 //! Invalid study component
374 exception StudyInvalidComponent {};
375 //! Invalid directory of the %study exception
376 exception StudyInvalidDirectory {};
377 //! Exception pointing that this name of the study has already been used.
378 exception StudyNameAlreadyUsed {};
379 //! study object already exists
380 exception StudyObjectAlreadyExists {};
381 //! Invalid name of the %study exception
382 exception StudyNameError {};
383 //! Invalid study comment
384 exception StudyCommentError {};
387 Determines whether the server has already been loaded or not.
392 Returns the PID of the server
397 Shutdown the Study process.
399 oneway void ShutdownWithExit();
401 /*! \brief The name of the %Study
403 This is equivalent to the methods setName() & getName()
405 readonly attribute string Name; // equivalent to getName()
407 //! Sequence containing %SObjects
408 typedef sequence<SObject> ListOfSObject;
409 //! Get the persistent reference to the %Study.
410 PersistentReference GetPersistentReference() raises(StudyInvalidReference);
412 /*! \brief indicate whether the %Study is empty
414 \return True if the %Study is empty
416 boolean IsEmpty() raises(StudyInvalidReference);
417 /*! \brief Find a %SComponent by its name.
419 \param aComponentName It's a string value in the Comment Attribute of the Component,
420 which is looked for, defining the data type of this Component.
422 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
425 SComponent FindComponent (in string aComponentName) raises(StudyInvalidReference);
427 /*! \brief Find a %SComponent by ID of the according %SObject
429 SComponent FindComponentID(in ID aComponentID) raises(StudyInvalidReference);
430 /*! \brief Find a %SObject by the Name Attribute of this %SObject
432 \param anObjectName String parameter defining the name of the object
433 \return The obtained %SObject
435 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
437 SObject FindObject (in string anObjectName) raises(StudyInvalidReference);
438 /*! \brief Find a %SObject by its ID
440 \param aObjectID This parameter defines the ID of the required object
441 \return The obtained %SObject
443 SObject FindObjectID (in ID aObjectID) raises(StudyInvalidReference);
444 /*! \brief Create a %SObject by its ID
446 \param aObjectID This parameter defines the ID of the required object
447 \return The created %SObject
449 SObject CreateObjectID (in ID aObjectID) raises(StudyInvalidReference);
450 /*! \brief Find a %SObject by IOR of the object belonging to this %SObject.
452 \param anObjectName This parameter defines the IOR of the object
453 \return The obtained %SObject
455 SObject FindObjectIOR (in ID aObjectIOR) raises(StudyInvalidReference);
456 /*! \brief Find in the study all %SObjects produced by a given %Component.
458 \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
459 \param aComponentName The name of the component, which objects are searched for.
461 ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName) raises(StudyInvalidReference);
462 /*! \brief Find a %SObject by the path to it.
464 \param thePath The path to the required %SObject.
465 \return The obtained %SObject.
467 SObject FindObjectByPath(in string thePath) raises(StudyInvalidReference);
468 /*! \brief Get the path to the %SObject.
470 string GetObjectPath(in Object theObject) raises(StudyInvalidReference);
472 /*! \brief Create a new iterator of child levels of the given %SObject.
474 \param aSO The given %SObject
475 \return A new iterator of child levels of the given %SObject.
477 ChildIterator NewChildIterator(in SObject aSO) raises(StudyInvalidReference);
479 /*! \brief Create a new iterator of the %SComponents.
481 \return A new iterator of the %SComponents.
483 SComponentIterator NewComponentIterator() raises(StudyInvalidReference);
485 /*! \brief Create a new %StudyBuilder to add or modify an object in the study.
487 \return A new %StudyBuilder.
489 <em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
491 StudyBuilder NewBuilder() raises(StudyInvalidReference);
492 /*! \brief Labels dependency
494 Updates the map with IOR attribute. It's an inner method used for optimization.
496 void UpdateIORLabelMap(in string anIOR, in string anEntry) raises(StudyInvalidReference);
498 /*! \brief Getting properties of the study
500 Returns the attribute, which contains the properties of this study.
502 <em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
505 AttributeStudyProperties GetProperties() raises(StudyInvalidReference);
506 /*! \brief Indicate whether the %study has been saved
508 attribute boolean IsSaved;
509 /*! \brief Indicate whether the %study has been modified and not saved.
511 Returns True if the %study has been modified and not saved.
513 boolean IsModified() raises(StudyInvalidReference);
515 /*! \brief Mark the %study as being modified and not saved.
517 void Modified() raises(StudyInvalidReference);
519 /*! \brief Indicate the file where the %study has been saved
521 attribute string URL;
523 /*! \brief List of %SObjects
525 Returns the list of %SObjects which refers to %anObject.
527 ListOfSObject FindDependances(in SObject anObject) raises(StudyInvalidReference);
529 /*! \brief The date of the last saving of the study
531 Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
533 string GetLastModificationDate() raises(StudyInvalidReference);
534 /*! \brief The list of modification dates of the study
536 Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
537 Note : the first modification begins the list.
539 ListOfDates GetModificationsDate() raises(StudyInvalidReference);
540 /*! \brief Object conversion.
542 Converts an object into IOR.
545 string ConvertObjectToIOR(in Object theObject);
546 /*! \brief Object conversion.
548 Converts IOR into an object.
551 Object ConvertIORToObject(in string theIOR);
553 /*! \brief Get a new %UseCaseBuilder.
555 UseCaseBuilder GetUseCaseBuilder() raises(StudyInvalidReference);
557 /*! \brief Clear a study object
559 void Clear() raises(StudyInvalidReference);
561 /*! \brief Initialization a study object
563 void Init() raises(StudyInvalidReference);
565 /*! \brief Open a study by url
567 Reads and activates the structure of the study %Objects.
568 \param aStudyUrl The path to the study
570 boolean Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception);
572 /*! \brief Saving the study in a file (or files).
575 \param theMultiFile If this parameter is True the study will be saved in several files.
576 \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
578 boolean Save(in boolean theMultiFile, in boolean theASCII) raises(StudyInvalidReference);
580 /*! \brief Saving the study in a specified file (or files).
582 Saves the study in a specified file (or files).
583 \param aUrl The path to the definite file in whcih the study will be saved
584 \param theMultiFile If this parameter is True the study will be saved in several files.
585 \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
587 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
589 boolean SaveAs(in URLPath aUrl, // if the file already exists
590 in boolean theMultiFile, // overwrite (as option)
592 raises(StudyInvalidReference);
594 Returns True, if the given %SObject can be copied to the clipboard.
596 boolean CanCopy(in SObject theObject) raises(StudyInvalidReference);
598 Returns True, if the given %SObject is copied to the clipboard.
599 \param theObject The %SObject which will be copied
601 boolean Copy(in SObject theObject) raises(StudyInvalidReference);
603 Returns True, if the object from the clipboard can be pasted to the given %SObject.
604 \param theObject The %SObject stored in the clipboard.
606 boolean CanPaste(in SObject theObject) raises(StudyInvalidReference);
608 Returns the %SObject in which the object from the clipboard was pasted to.
609 \param theObject The %SObject which will be pasted
610 \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
611 an object into a study, which is protected for modifications.
613 SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
615 /*! \brief Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case.
617 void EnableUseCaseAutoFilling(in boolean isEnabled) raises(StudyInvalidReference);
620 Functions for internal usage only
622 void AddPostponed(in string theIOR) raises(StudyInvalidReference);
624 void AddCreatedPostponed(in string theIOR) raises(StudyInvalidReference);
626 void RemovePostponed(in long theUndoLimit) raises(StudyInvalidReference);
628 void UndoPostponed(in long theWay) raises(StudyInvalidReference);
630 boolean DumpStudy(in string thePath,
631 in string theBaseName,
632 in boolean isPublished,
633 in boolean isMultiFile) raises(StudyInvalidReference);
635 /*! \brief Get an AttributeParameter used to store common parameters for given %theSavePoint.
637 \param theID identifies a common parameters set (Example: "Interface Applicative")
638 \param theSavePoint is number of a set of parameters as there can be several sets
640 AttributeParameter GetCommonParameters(in string theID, in long theSavePoint) raises(StudyInvalidReference);
642 /*! \brief Get an AttributeParameter used to store parameters for given %theModuleName.
644 \param theID identifies a common parameters set (Example: "Interface Applicative")
645 \param theModuleName is a name of the module (Example: "Geometry")
646 \param theSavePoint is number of a set of parameters as there can be several sets
648 AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint) raises(StudyInvalidReference);
651 /*! \brief Get a default Python script to restore visual parameters for given %theModuleName.
653 \param theModuleName is a name of the module (Example: "Geometry")
654 \param indent is a string to use for script indentation
656 string GetDefaultScript(in string theModuleName, in string indent) raises(StudyInvalidReference);
659 Private method, returns an implementation of this Study.
660 \param theHostname is a hostname of the caller
661 \param thePID is a process ID of the caller
662 \param isLocal is set True if the Study is launched locally with the caller
664 long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
667 /*! \brief Mark this Study as being locked by the given locker.
669 The lock status can be checked by method IsStudyLocked
670 \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that locks the study.
672 void SetStudyLock(in string theLockerID) raises(StudyInvalidReference);
674 /*! \brief Indicate if the Study is locked
676 Returns True if the Study was marked locked.
678 boolean IsStudyLocked() raises(StudyInvalidReference);
680 /*! \brief Mark this Study as being unlocked by the given locker.
682 The lock status can be checked by method IsStudyLocked
683 \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that unlocks the study.
685 void UnLockStudy(in string theLockerID) raises(StudyInvalidReference);
687 /*! \brief Get the list of IDs of the Study's lockers.
689 ListOfStrings GetLockerID() raises(StudyInvalidReference);
691 /*! \brief Create real variable with Name theVarName and value theValue
693 (or set if variable value into theValue already exists)
694 \param theVarName is a name of the variable
695 \param theVarName is a value of the variable.
697 void SetReal( in string theVarName, in double theValue ) raises(StudyInvalidReference);
699 /*! \brief Create integer variable with Name theVarName and value theValue
701 (or set if variable value into theValue already exists)
702 \param theVarName is a name of the variable
703 \param theVarName is a value of the variable.
705 void SetInteger( in string theVarName, in long theValue ) raises(StudyInvalidReference);
706 /*! \brief Create boolean variable with Name theVarName and value theValue
708 (or set if variable value into theValue already exists)
709 \param theVarName is a name of the variable
710 \param theVarName is a value of the variable.
712 void SetBoolean( in string theVarName, in boolean theValue ) raises(StudyInvalidReference);
714 /*! \brief Create string variable with Name theVarName and value theValue
716 (or set if variable value into theValue already exists)
717 \param theVarName is a name of the variable
718 \param theVarName is a value of the variable.
720 void SetString( in string theVarName, in string theValue ) raises(StudyInvalidReference);
722 /*! \brief Set current value as double for string variable
724 void SetStringAsDouble( in string theVarName, in double theValue ) raises(StudyInvalidReference);
726 /*! \brief Get value of a real variable
728 \param theVarName is a name of the variable.
730 double GetReal( in string theVarName ) raises(StudyInvalidReference);
732 /*! \brief Get value of an integer variable
734 \param theVarName is a name of the variable.
736 long GetInteger( in string theVarName ) raises(StudyInvalidReference);
738 /*! \brief Get value of a boolean variable
740 \param theVarName is a name of the variable.
742 boolean GetBoolean( in string theVarName ) raises(StudyInvalidReference);
744 /*! \brief Get value of a string variable
746 \param theVarName is a name of the variable.
748 string GetString( in string theVarName ) raises(StudyInvalidReference);
751 /*! \brief Indicate if a variable is real
753 Return true if variable is real otherwise return false.
754 \param theVarName is a name of the variable.
756 boolean IsReal( in string theVarName ) raises(StudyInvalidReference);
758 /*! \brief Indicate if a variable is integer
760 Return true if variable is integer otherwise return false.
761 \param theVarName is a name of the variable.
763 boolean IsInteger( in string theVarName ) raises(StudyInvalidReference);
765 /*! \brief Indicate if a variable is boolean
767 Return true if variable is boolean otherwise return false.
768 \param theVarName is a name of the variable.
770 boolean IsBoolean( in string theVarName ) raises(StudyInvalidReference);
772 /*! \brief Indicate if a variable is string
774 Return true if variable is string otherwise return false.
775 \param theVarName is a name of the variable.
777 boolean IsString( in string theVarName ) raises(StudyInvalidReference);
779 /*! \brief Indicate if a variable exists in the study
781 Return true if variable exists in the study,
782 otherwise return false.
783 \param theVarName is a name of the variable.
785 boolean IsVariable( in string theVarName ) raises(StudyInvalidReference);
787 /*! \brief Get names of all variables from the study.
789 ListOfStrings GetVariableNames() raises(StudyInvalidReference);
791 /*! \brief Remove a variable
793 Remove variable with the specified name from the study with substitution of its value.
795 \param theVarName Name of the variable.
796 \return Status of operation.
798 boolean RemoveVariable( in string theVarName ) raises(StudyInvalidReference);
800 /*! \brief Rename a variable
802 Rename variable with the specified name within the study.
804 \param theVarName Name of the variable.
805 \param theNewVarName New name for the variable.
806 \return Status of operation.
808 boolean RenameVariable( in string theVarName, in string theNewVarName ) raises(StudyInvalidReference);
810 /*! \brief Indicate whether variable is used
812 Check that variable is used in the study.
814 \param theVarName Name of the variable.
815 \return Variable usage.
817 boolean IsVariableUsed( in string theVarName ) raises(StudyInvalidReference);
819 /*! \brief Parse variables used for object creation
821 \param string with variables, separated by special symbol.
822 \return Variables list.
824 ListOfListOfStrings ParseVariables( in string theVars ) raises(StudyInvalidReference);
827 Attach an observer to the Study
829 \param theObserver observer being attached
830 \param modify when \c true, observer receives any object's modification events;
831 otherwise observer receives object's creation events only
833 void attach(in SALOMEDS::Observer theObserver, in boolean modify);
835 Detach an observer from the Study
837 \param theObserver observer to be detached
839 void detach(in SALOMEDS::Observer theObserver);
842 //==========================================================================
843 /*! \brief %SObject interface
845 The objects in the %study are built by the %StudyBuilder. The %SObject interface
846 provides methods for elementary inquiries, like getting an object %ID or its attribuites.
849 <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
850 in the tree-type data structure.
851 <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
852 ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
854 //==========================================================================
856 interface SObject : SALOME::GenericObj
858 /*! Name of the %SObject
860 attribute string Name; // equivalent to setName() & getName()
862 /*! Returns true if the %SObject does not belong to any %Study
866 /*! Gets an object %ID
867 \return ID of the %SObject.
871 /*! Acquisition of the father %Component of the %SObject
872 \return The father %Component of the %SObject.
874 SComponent GetFatherComponent();
876 /*! Acquisition of the father %SObject of the %SObject
877 \return the father %SObject of the given %SObject.
881 /*! Gets the %tag of a %SObject
882 \return the %tag of a %SObject.
886 /*! Returns a tag of the last child %SObject (if any) of this %SObject.
887 Returns zero if this %SObject has no children.
889 short GetLastChildTag();
891 /*! Gets the depth of a %SObject
892 \return the depth of a %SObject.
896 /*! Looks for subobjects of a given %SObject.
897 \param atag Tag of the given %SObject
898 \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
900 boolean FindSubObject (in long atag, out SObject obj);
902 /*! Looks for attributes of a given %SObject
903 \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
904 \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
906 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
908 boolean FindAttribute(out GenericAttribute anAttribute,
909 in string aTypeOfAttribute);
911 /*! Looks for a %SObject which the given %SObject refers to.
912 \return The object which the given %SObject refers to as well as True if it finds
915 boolean ReferencedObject(out SObject obj); // A REVOIR
917 /*! Gets all attributes of a given %SObject
918 \return The list of all attributes of the given %SObject.
920 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
923 ListOfAttributes GetAllAttributes();
925 /*! Gets the CORBA object by its own IOR attribute.
926 Returns nil, if can't.
927 \return The CORBA object of the %SObject.
932 Returns the name attribute value of this SObject.
933 Returns empty string if there is no name attribute.
938 Returns the comment attribute value of this SObject.
939 Returns empty string if there is no comment attribute.
944 Returns the IOR attribute value of this SObject.
945 Returns empty string if there is no IOR attribute.
950 Set an attribute value (of type string)
951 \param name the name of the attribute
952 \param value the value of the attribute
954 void SetAttrString(in string name, in string value);
957 Private method, returns an implementation of this SObject.
958 \param theHostname is a hostname of the caller
959 \param thePID is a process ID of the caller
960 \param isLocal is set True if the SObject is launched locally with the caller
962 long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
966 //==========================================================================
967 /*! \brief %Generic attribute interface
969 %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
971 //==========================================================================
972 interface GenericAttribute : SALOME::GenericObj
974 /*! \brief Exception locking all changes
976 This exception locks all modifications in attributes.
978 exception LockProtection {};
979 /*! \brief Method CheckLocked
981 Checks whether the %Study is protected for modifications.
983 \note <BR>This exception is raised only outside a transaction.
985 void CheckLocked() raises (LockProtection);
990 //! Get the class type
991 string GetClassType();
994 SObject GetSObject();
996 //! Private method, returns an implementation of this GenericAttribute.
998 \param theHostname is a hostname of the caller
999 \param thePID is a process ID of the caller
1000 \param isLocal is set True if the GenericAttribute is launched locally with the caller
1002 long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1007 //==========================================================================
1008 /*! \brief %SComponent interface
1010 The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
1011 The %SComponent interface is a specialization of the %SObject interface.
1012 It inherits the most of its methods from the %SObject interface.
1014 //==========================================================================
1015 interface SComponent : SObject
1017 /*! \brief Gets the data type of the given %SComponent
1019 \return The data type of this %SComponent.
1021 string ComponentDataType();
1022 /*! \brief Gets the IOR of the given component
1024 \return True (if there is an instance of the given component) and its IOR.
1026 boolean ComponentIOR (out ID theID); //returns True if there is an instance
1027 //In this case ID identifies this one
1031 //==========================================================================
1032 /*! \brief %SComponentIterator interface
1034 This interface contains the methods allowing to iterate over all components in the list.
1035 The search is started from the first %SComponent in the list.
1037 //==========================================================================
1038 interface SComponentIterator : SALOME::GenericObj
1041 \brief Activates the %SComponentIterator.
1044 /*! \brief Method More
1046 \return True if there is one more %SComponent in the list.
1050 \brief Moves the iterator to the next %SComponent in the list.
1054 \brief Returns the %SComponent corresponding to the current %SComponent found by the iterator.
1056 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
1062 //==========================================================================
1063 /*! \brief %ChildIterator interface
1065 This interface contains methods which allow to iterate over all child
1068 //==========================================================================
1069 interface ChildIterator : SALOME::GenericObj
1073 \brief Activates the %ChildIterator.
1078 \brief Activates the %ChildIterator for all child levels.
1080 \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
1082 void InitEx(in boolean allLevels);
1083 /*! \brief Method More
1085 \return True if there is one more %ChildIterator in the list.
1089 \brief Passes the iterator to the next level.
1093 \brief Returns the %SObject corresponding to the current object found by the iterator.
1098 //==========================================================================
1099 //==========================================================================
1100 /*! \brief Interface of the %UseCaseIterator.
1102 This interface contains a set of methods used for iteration over the objects in the use case.
1104 interface UseCaseIterator : SALOME::GenericObj
1107 Activates the %UseCaseIterator.
1108 \param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
1110 void Init(in boolean allLevels);
1113 \return True if the %UseCaseIterator finds one more object.
1117 Passes the iterator to the next object.
1121 Returns the %SObject corresponding to the current object found by the Iterator.
1126 //==========================================================================
1127 //==========================================================================
1128 /*! \brief Interface of the %UseCaseBuilder
1130 Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1131 The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1133 interface UseCaseBuilder : SALOME::GenericObj
1136 Adds to the use case an object as a child of the current object of the use case.
1138 \param theObject The added %SObject.
1139 \return True if this %SObject has been added in the use case.
1141 boolean Append(in SObject theObject);
1143 Removes an object from the use case.
1145 \param theObject The deleted %SObject
1146 \return True if this %SObject has been deleted from the use case.
1148 boolean Remove(in SObject theObject);
1150 Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1152 boolean AppendTo(in SObject theFather, in SObject theObject);
1154 Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1156 boolean InsertBefore(in SObject theFirst, in SObject theNext);
1158 Sets the current object of the use case.
1160 boolean SetCurrentObject(in SObject theObject);
1162 Makes the root object to be the current object of the use case.
1164 boolean SetRootCurrent();
1166 Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1168 boolean HasChildren(in SObject theObject);
1170 Returns True if children of the given object <VAR>theObject</VAR> of the use case tree were sorted successfully.
1172 boolean SortChildren(in SObject theObject, in boolean theAscendingOrder);
1174 Gets father object of the given object <VAR>theObject</VAR> in the use cases tree.
1176 SObject GetFather(in SObject theObject);
1178 Sets the name of the use case.
1180 boolean SetName(in string theName);
1182 Gets the name of the use case.
1186 Returns True if the given object <VAR>theObject</VAR> represents a use case.
1188 boolean IsUseCase(in SObject theObject);
1190 Returns True if the given object <VAR>theObject</VAR> is included in the use cases tree on any level.
1192 boolean IsUseCaseNode(in SObject theObject);
1194 Gets the current object of the use case.
1196 SObject GetCurrentObject();
1198 Creates a new use case in the use case browser.
1200 SObject AddUseCase(in string theName);
1202 Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1204 UseCaseIterator GetUseCaseIterator(in SObject theObject);
1206 //==========================================================================
1207 /*! \brief %Driver interface
1209 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
1210 can be called by any component and which provide the following functionality:
1212 <li> publishing in the study of the objects created by a definite component
1213 <li> saving/loading of the data created by a definite component. These methods are called when loading/saving a study containing the data created by a definite component.
1214 <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
1215 <li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
1219 //==========================================================================
1223 /*! \brief Saving the data produced by a definite component.
1225 This method is called when saving a study.
1226 \param theComponent %SComponent corresponding to this Component
1227 \param theURL The path to the file in which the data will be saved.
1228 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1229 \return A byte stream TMPFile that contains all saved data
1231 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1236 TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1238 /*! \brief Saving the data in ASCII format produced by a definite component.
1240 This method is called when saving a study in ASCII format.
1241 \param theComponent %SComponent corresponding to this Component
1242 \param theURL The path to the file in which the data will be saved.
1243 \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
1244 \return A byte stream TMPFile that will contain all saved data
1246 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1249 TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1251 /*! \brief Loading the data.
1253 This method is called when opening a study.
1254 \param theComponent %SComponent corresponding to this Component
1255 \param theStream The file which contains all data saved by the component on Save method
1256 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1260 boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1262 /*! \brief Loading the data from files in ASCII format.
1264 This method is called when opening a study.
1265 \param theComponent %SComponent corresponding to this Component
1266 \param theStream The file which contains all data saved by the component on Save method
1267 \param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
1271 boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1273 /*! \brief Closing of the study
1275 This method Close is called when closing a study.
1276 \param aSComponent The according %SComponent
1279 void Close (in SComponent aSComponent);
1280 //void Close ( in string aIORSComponent);
1282 /*! Gets the type of the data
1284 \return The type of data produced by the Component in the study.
1287 string ComponentDataType();
1289 // Driver Transient -> persistent called for each object in study
1291 Transforms IOR of a given %SObject into PersistentID. It is called for each
1292 object in the %study.
1293 \note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
1294 study is saved these references are transformed into persintent IDs.
1296 \param theSObject The given %SObject.
1297 \param IORString The IOR of the given %SObject.
1298 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1299 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1301 \return The persistent ID of the given %SObject
1304 string IORToLocalPersistentID (in SObject theSObject,
1305 in string IORString,
1306 in boolean isMultiFile,
1307 in boolean isASCII);
1309 Transforms PersistentID into IOR of the object. It is called for each
1310 object in the %study.
1312 \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
1313 study is open, these references are transformed into persintent IORs.
1315 \param theSObject The given %SObject.
1316 \param IORString The IOR of the given %SObject.
1317 \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1318 \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1320 \return The IOR of the given %SObject
1323 string LocalPersistentIDToIOR (in SObject theSObject,
1324 in string aLocalPersistentID,
1325 in boolean isMultiFile,
1327 raises (SALOME::SALOME_Exception);
1329 // Publishing in the study
1330 /*! Publishing in the study
1332 \return True if the given %Component can publish a definite object with a given IOR in the %study.
1333 \param theIOR The IOR of a definite object
1335 boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1336 /*! \brief Publishing in the study
1338 Publishes the given object in the %study, using the algorithm of this component.
1339 \param theSObject If this parameter is null the object is published for the first time. Otherwise
1340 this parameter should contain a reference to the object published earlier
1341 \param theObject The object which is published
1342 \param theName The name of the published object. If this parameter is empty, the name is generated
1343 automatically by the component.
1345 \return The published %SObject.
1347 SObject PublishInStudy(in SObject theSObject, in Object theObject, in string theName);
1349 // copy/paste methods
1352 Returns True, if the given %SObject can be copied to the clipboard.
1354 \param theObject The given %SObject which should be copied.
1356 boolean CanCopy(in SObject theObject);
1358 Returns the object %ID and the %TMPFile of the object from the given %SObject.
1360 TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1362 Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1364 boolean CanPaste(in string theComponentName, in long theObjectID);
1366 Returns the %SObject of the pasted object.
1368 SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);