1 //=====================================================
3 // Created : Thu Nov 29 21:25:39 2001
4 // Author : Yves FRICAUD
6 // Copyright : Open CASCADE 2001
8 //=====================================================
12 \image html Application-About.png
15 /*! \page page1 Mapping of IDL definitions to Python language.
16 \section Intro Introduction
17 %SALOME PRO is a distributed client/server application using the Common Object Request Broker Architecture (CORBA).
18 CORBA architecture uses the Interface Definition Language (IDL), which specifies interfaces between CORBA objects. So with help of IDL
19 CORBA's language independence is ensured . Because interfaces described in IDL can be mapped to the most of currently used programming languages, CORBA applications and components are thus
20 independent of the language(s) used to implement them. In other words, a client written in C++ can communicate with a server written in Java, which in turn can communicate with
21 another server written in COBOL, and so forth.
23 One important thing to remember about IDL is that it is not an implementation language. That is, applications can't be written in IDL. The sole purpose of IDL is to define interfaces;
24 providing implementations for these interfaces is performed using some other language.
26 This page contains an abridged reference manual for mapping of IDL definitions to Python language. It will be useful for Python programmers who are not familiar
27 with IDL language. All examples are taken from %SALOME PRO source files.
28 The complete version of Python Language Mapping Specification can be found <A HREF="http://www.omg.org">here.</A>
30 <BR><STRONG>CONTENTS:</STRONG>
39 \subsection subsection1 Using Scoped Names
41 Python implements a module concept that is similar to the IDL scoping mechanisms,
42 except that it does not allow for nested modules. In addition, Python requires each
43 object to be implemented in a module; globally visible objects are not supported.
45 Because of these constraints, scoped names are translated into Python using the
48 \95 An IDL module mapped into a Python module. Modules containing modules are
49 mapped to packages (i.e., directories with an <STRONG>__init__</STRONG> module containing all
50 definitions excluding the nested modules). An implementation can chose to map toplevel
51 definitions (including the module CORBA) to modules in an implementationdefined
52 package, to allow concurrent installations of different CORBA runtime
53 libraries. In that case, the implementation must provide additional modules so that
54 toplevel modules can be used without importing them from a package.
56 \95 For all other scopes, a Python class is introduced that contains all the definitions
59 \95 Other global definitions (except modules) appear in a module whose name is
60 implementation dependent. Implementations are encouraged to use the name of the
61 IDL file when defining the name of that module.
67 interface StudyManager {
68 void Close(in Study aStudy);
73 would introduce a module SALOMEDS.py, which contains the following definitions:
78 def _Close(self,aStudy):
79 pass #interfaces are discussed later
82 To avoid conflicts, IDL names that are also Python identifiers are prefixed with an underscore (
\91_
\92).
84 \subsection subsection2 Mapping for Template and Array Types
86 Both the bounded and the unbounded string type of IDL are mapped to the Python
87 string type. Wide strings are represented by an implementation-defined type with the
90 \95 For the wide string X and the integer n, X[n] returns the nth character, which is a
91 wide string of length 1.
93 \95 len(X) returns the number of characters of wide string X.
95 \95 CORBA.wstr(c) returns a wide character with the code point c in an
96 implementation-defined encoding.
98 \95 X+Y returns the concatenation of wide strings X and Y.
100 \95 CORBA.word(CORBA.wstr(c)) == c
102 The sequence template is mapped to sequence objects (e.g., tuples or lists).
103 Applications should not assume that values of a sequence type are mutable. Sequences
104 and arrays of octets and characters are mapped to the string type for efficiency reasons.
106 For example, given the IDL definitions
110 typedef sequence <string> StringSeq;
112 interface AttributeTableOfInteger : GenericAttribute {
114 void SetRowTitles(in StringSeq theTitles) raises(IncorrectArgumentLength);
119 a client could invoke the operation
122 print My_AttributeTableOfInteger.SetRowTitles(["X","F"])
125 Array types are mapped like sequence templates. The application in this example also expects an
126 IncorrectArgumentLength exception if it passes sequences that violate the bounds constraint or
127 arrays of wrong size.
129 Another example with arrays. The following IDL definition
133 typedef sequence<GenericAttribute> ListOfAttributes;
135 ListOfAttributes GetAllAttributes();
147 attributes = My_SObject.GetAllAttributes()
149 length = len(attributes)
151 print "Attributes number = ", length
155 \subsection subsection3 Mapping for Objects and Operations
157 A CORBA object reference is represented as a Python object at run-time. This object
158 provides all the operations that are available on the interface of the object. Although
159 this specification does not mandate the use of classes for stub objects, the following
160 discussion uses classes to indicate the interface.
162 The nil object is represented by <STRONG>None</STRONG>.
164 If an operation expects parameters of the IDL Object type, any Python object
165 representing an object reference might be passed as actual argument.
167 If an operation expects a parameter of an abstract interface, either an object
168 implementing that interface, or a value supporting this interface may be passed as
169 actual argument. The semantics of abstract values then define whether the argument is
170 passed by value or by reference.
172 Operations of an interface map to methods available on the object references.
173 Parameters with a parameter attribute of <STRONG>in</STRONG> or <STRONG>inout</STRONG>
174 are passed from left to right tothe method, skipping <STRONG>out</STRONG> parameters.
175 The return value of a method depends on the number of <STRONG>out</STRONG> parameters
176 and the return type. If the operation returns a value, this
177 value forms the first <VAR>result value</VAR>. All <STRONG>inout</STRONG> or <STRONG>out</STRONG>
178 parameters form consecutive <VAR>result values</VAR>. The method result depends then on the number
179 of <VAR>result values</VAR>:
181 \95 If there is no <VAR>result value</VAR>, the method returns None.
183 \95 If there is exactly one <VAR>result value</VAR>, it is returned as a single value.
185 \95 If there is more than one <VAR>result value</VAR>, all of them are packed into a tuple, and this
188 Assuming the IDL definition
192 interface StudyBuilder{
193 boolean FindAttribute ( in SObject anObject,
194 out GenericAttribute anAttribute,
195 in string aTypeOfAttribute );
203 from SALOMEDS import StudyBuilder;
206 res,A=my_StudyBuilder.FindAttribute(Sobj, "AttributeSequenceOfReal")
209 In this example <STRONG>A</STRONG> corresponds to the return value <STRONG>anAttribute</STRONG> and
210 <STRONG>res</STRONG> to the <STRONG>boolean</STRONG> return value.
212 If an interface defines an <STRONG>attribute name</STRONG>, for example, the attribute is mapped into an
213 operation <STRONG>_get_name</STRONG>. If the attribute is not <STRONG>readonly</STRONG>, there is an
214 additional operation <STRONG>_set_name</STRONG>.
221 attribute string Name;
226 is equal to the following
229 from SALOMEDS import Study
231 Name=My_Study._get_name();
232 Name=My_Study._set_name();
235 \subsection subsection4 Narrowing Object References
237 Python objects returned from CORBA operations or pseudo-operations (such as
238 string_to_object) might have a dynamic type, which is more specific than the
239 static type as defined in the operation signature.
241 Since there is no efficient and reliable way of automatically creating the most specific
242 type, explicit narrowing is necessary. To narrow an object reference <STRONG>A</STRONG> to an interface
243 class <STRONG>AttributeSequenceOfReal</STRONG>, the client can use the following operation
246 A = A._narrow(SALOMEDS.AttributeSequenceOfReal)
249 \subsection subsection5 Mapping for Exceptions
251 An IDL exception is translated into a Python class derived from
252 CORBA.UserException. System exceptions are derived from CORBA.SystemException.
253 Both base classes are derived from CORBA.Exception. The parameters of the
254 exception are mapped in the same way as the fields of a struct definition. When
255 raising an exception, a new instance of the class is created; the constructor
256 expects the exception parameters. For example, the definition
260 interface StudyBuilder{
261 exception LockProtection {};
262 void CommitCommand() raises(LockProtection);
267 could be used caught as
270 from SALOMEDS import StudyBuilder;
273 my_StudyBuilder.CommitCommand();
274 except StudyBuilder.LockProtection,value:
275 print "Error! Study is locked for modifications"
279 \subsection subsection6 Mapping for Enumeration Types
281 An enumeration is mapped into a number of constant objects in the name space where
282 the enumeration is defined. An application may only test for equivalence of two
283 enumeration values, and not assume that they behave like numbers.
284 For example, the definition
290 enum PrsObjType{ TCURVE, TTABLE, TMESH, TCONTAINER,
291 TSCALARMAP, TISOSURFACE, TDEFORMEDSHAPE,
292 TCUTPLANES, TVECTORS };
297 introduces the objects
300 from VISU import PrsObject
301 VISU.PrsObjType.TCURVE,VISU.PrsObjType.TTABLE,VISU.PrsObjType.TMESH,VISU.PrsObjType.TCONTAINER,
302 VISU.PrsObjType.TSCALARMAP,VISU.PrsObjType.TISOSURFACE,VISU.PrsObjType.TDEFORMEDSHAPE,VISU.PrsObjType.TCUTPLANES,
303 VISU.PrsObjType.TVECTORS
306 \subsection subsection7 Mapping for Structured Types
308 An IDL struct definition is mapped into a Python class or type. For each field in the
309 struct, there is a corresponding attribute in the class with the same name as the field.
310 The constructor of the class expects the field values, from left to right.
311 For example, the IDL definition
324 could be used in the Python statements
327 Date=SDate(30, 12, 15, 26, 1, 79)
328 print Date.Second,Date.Minute,Date.Hour,Date.Day,Date.Month,Date.Year
331 /*! \page page2 Mapping of SALOME IDL definitions to Python language.
334 - <B>%SALOME STUDY module</B>
335 - <A href=HTML/SALOMEDS.html>Mapping of %SALOMEDS functions</A>
336 - <A href=HTML/SALOMEDS_Attributes.html>Mapping of SALOMEDS_Attributes functions</A>
337 - <B>%SAlOME KERNEL module</B>
338 - <A href=HTML/Med_Gen.html>Mapping of %Med_Gen functions</A>
339 - <A href=HTML/SALOME_Session.html>Mapping of %SALOME_Session functions</A>
340 - <A href=HTML/SALOME_ModuleCatalog.html>Mapping of %SALOME_ModuleCatalog functions</A>
341 - <A href=HTML/SALOME_Exception.html>Mapping of %SALOME_Exception functions</A>
342 - <A href=HTML/SALOME_Component.html>Mapping of %SALOME_Component functions</A>
343 - <B>%SALOME MED component</B>
344 - <A href=HTML/MED.html>Mapping of %Med functions</A>
345 - <B>%SALOME SUPERVISION module</B>
346 - <A href=HTML/SUPERV.html>Mapping of %SUPERV functions</A>
347 - <B>%SALOME %VISU module</B>
348 - <A href=HTML/VISU_Gen.html>Mapping of %VISU_Gen functions</A>
352 /*! \defgroup Study SALOME STUDY module
356 \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment
357 and modification of the %Study
360 #ifndef _SALOMEDS_IDL_
361 #define _SALOMEDS_IDL_
363 #include "SALOME_Exception.idl"
366 This package contains the interfaces used for creation, managment
367 and modification of the %Study
371 const string SALOMEDS__doc__ = "This package contains the interfaces used for creation, \nmanagment and modification of the study.";
373 Name of the file in which the %Study is saved.
378 /*! Main identifier of an object in %SALOME application
382 /*! While saving the data, IOR is transformed into persistent reference
384 typedef string PersistentReference;
386 /*! IOR of the study in %SALOME application
388 typedef string SalomeReference;
389 /*! List of names of open studies in a %SALOME session
391 typedef sequence<string> ListOfOpenStudies;
392 /*! List of file names
394 typedef sequence<string> ListOfFileNames;
395 /*! List of modification dates of the study
397 typedef sequence<string> ListOfDates ;
398 /*! An unbounded sequence of strings
400 typedef sequence<string> ListOfStrings ;
401 /*! A byte stream which is used for binary data transfer between components
403 typedef sequence<octet> TMPFile;
405 // Reference to other objects is treated with function AddReference
406 // and ReferencedObject
407 // All other type of attributes defined in AttributeType enum are
408 // treated with AddAdttribute and GetAttribute
409 // The difference is made because Reference attribute don't contain
410 // strings but reference to ID of other objects
412 interface GenericAttribute;
414 interface StudyManager;
415 interface StudyBuilder;
417 interface SComponent;
418 interface SComponentIterator;
419 interface ChildIterator;
421 interface AttributeStudyProperties;
422 interface UseCaseIterator;
423 interface UseCaseBuilder;
425 /*! List of attributes
427 typedef sequence<GenericAttribute> ListOfAttributes;
428 /*! Exception indicating that this feature hasn't been implemented
430 exception NotImplemented {};
433 //===========================================================================
434 /*! \brief %Study Interface
436 The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
437 Most of the %Study operations are handled by the StudyManager and the StudyBuilder.
438 What is left in the %Study interface are elementary inquiries.
439 (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
440 and set methods.) A %Study is explored by a set of tools, mainly iterators
441 , which are described further. Nevertheless, the %Study
442 interface allows the search of an object by name or by ID.
444 <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
445 In general it's a string of names of directories divided by a slash '/'.
446 <BR><VAR>The Context</VAR> is the current directory of an object.</P>
451 exception StudyInvalidContext {};
452 exception StudyInvalidComponent {};
453 /*! Invalid directory of the %study exception
455 exception StudyInvalidDirectory {};
456 /*! Exception pointing that this name of the study has already been used.
458 exception StudyNameAlreadyUsed {};
459 exception StudyObjectAlreadyExists {};
460 /*! Invalid name of the %study exception
462 exception StudyNameError {};
463 exception StudyCommentError {};
464 /*! \brief The name of the %Study
466 This is equivalent to the methods setName() & getName()
468 attribute string Name; // equivalent to setName() & getName()
469 /*! \brief The ID of the %Study
471 This is equivalent to the methods setID() & getID()
473 attribute short StudyId;
474 /*! Sequence containing %SObjects
476 typedef sequence<SObject> ListOfSObject;
478 Gets a persistent reference to the %Study.
480 PersistentReference GetPersistentReference();
481 const string GetPersistentReference__doc__ = "Gets a persistent reference to the study.";
483 Gets a transient reference to the %Study.
485 SalomeReference GetTransientReference();
486 const string GetTransientReference__doc__ = "Gets a transient reference to the study.";
489 Returns True if the %Study is empty
492 const string IsEmpty__doc__ = "Returns True if the study is empty.";
494 Allows to find a %SComponent by its name.
495 \param aComponentName It's a string value in the Comment Attribute of the Component,
496 which is looked for, defining the data type of this Component.
498 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
500 SComponent FindComponent (in string aComponentName);
501 const string FindComponent__doc__ = "Allows to find a SComponent by its name.";
503 Allows to find a %SComponent by ID of the according %SObject
505 SComponent FindComponentID(in ID aComponentID);
506 const string FindComponentID__doc__ = "Allows to find a SComponent by ID of the according SObject.";
508 Allows to find a %SObject by the Name Attribute of this %SObject
509 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
512 SObject FindObject (in string anObjectName);
513 const string FindObject__doc__ = "Allows to find a SObject by the Name Attribute of this SObject.";
515 Allows to find a %SObject by its ID
517 SObject FindObjectID (in ID aObjectID);
518 const string FindObjectID__doc__ = "Allows to find a SObject by its ID";
520 Allows to find a %SObject by IOR of the object belonging to this %SObject.
522 SObject FindObjectIOR (in ID aObjectIOR);
523 const string FindObjectIOR__doc__ = "Allows to find a SObject by IOR of the object belonging to this SObject.";
525 Returns a list of %SObjects belonging to this %Component. The Name Attribute
526 of these %SObjects should correspond to <VAR>anObjectName</VAR>.
528 ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
529 const string FindObjectByName__doc__ = "Returns a list of SObjects belonging to this Component.";
531 Allows to find a %SObject by the path to it.
533 SObject FindObjectByPath(in string thePath);
534 const string FindObjectByPath__doc__ = "Allows to find a SObject by the path to it.";
536 Returns the path to the %SObject.
538 string GetObjectPath(in Object theObject);
539 const string GetObjectPath__doc__ = "Returns the path to the SObject";
542 Sets the context of the %Study.
543 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
546 void SetContext(in string thePath);
547 const string SetContext__doc__ = "Sets the context of the study";
549 Gets the context of the %Study
550 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
554 const string GetContext__doc__ = "Gets the context of the study";
556 Returns a list of names of objects corresponding to the context.
557 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
559 ListOfStrings GetObjectNames(in string theContext);
560 const string GetObjectNames__doc__ = "Returns a list of names of objects corresponding to the context.";
562 Returns a list of names of directories and subdirectories corresponding to the context.
563 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
565 ListOfStrings GetDirectoryNames(in string theContext);
566 const string GetDirectoryNames__doc__ = "Returns a list of names of directories and subdirectories corresponding to the context.";
568 Returns a list of names of Files corresponding to the context.
569 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
571 ListOfStrings GetFileNames(in string theContext);
572 const string GetFileNames__doc__ = "Returns a list of names of Files corresponding to the context.";
574 Returns a list of names of Components corresponding to the context.
575 \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
577 ListOfStrings GetComponentNames(in string theContext);
578 const string GetComponentNames__doc__ = "Returns a list of names of Components corresponding to the context.";
579 /*! \brief Creation of a new iterator of child levels
581 Creates a new iterator of child levels of the %SObject
583 ChildIterator NewChildIterator(in SObject aSO);
584 const string NewChildIterator__doc__ = "Creates a new iterator of child levels of the SObject";
585 /*! \brief Creation of a new iterator of the %SComponent
587 Creates a new iterator of the %SComponent.
589 SComponentIterator NewComponentIterator();
590 const string NewComponentIterator__doc__ = "Creates a new iterator of the SComponent.";
591 /*! \brief Creation of a %StudyBuilder
593 Creates a new %StudyBuilder to add or modify an object in the study.
594 <BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
597 StudyBuilder NewBuilder() ;
598 const string NewBuilder__doc__ = "Creates a new StudyBuilder to add or modify an object in the study.";
599 /*! \brief Labels dependency
601 Updates the map with IOR attribute. It's an inner method used for optimization.
603 void UpdateIORLabelMap(in string anIOR, in string anEntry);
604 const string UpdateIORLabelMap__doc__ = "Updates the map with IOR attribute. It's an inner method used for optimization.";
606 /*! \brief Getting properties of the study
608 Returns the attriubte, which contains the properties of this study.
609 <BR><VAR>See also <A href=exemple/Example20.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
612 AttributeStudyProperties GetProperties();
613 const string GetProperties__doc__ = "Returns the attriubte, which contains the properties of this study.";
615 Determines whether the %study has been saved
617 attribute boolean IsSaved;
618 const string IsSaved__doc__ = "Determines whether the study has been saved.";
620 Returns True if the %study has been modified and not saved.
622 boolean IsModified();
623 const string IsModified__doc__ = "Returns True if the study has been modified and not saved.";
625 Determines the file where the %study has been saved
627 attribute string URL;
629 /*! \brief List of %SObjects
631 Returns the list of %SObjects which refers to %anObject.
633 ListOfSObject FindDependances(in SObject anObject);
634 const string FindDependances__doc__ = "Returns the list of SObjects which refers to anObject.";
636 /*! \brief The date of the last saving of the study
638 Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
640 string GetLastModificationDate();
641 const string GetLastModificationDate__doc__ = "Returns the date of the last saving of study with format: DD/MM/YYYY HH:MM";
642 /*! \brief The list of modification dates of the study
644 Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
645 Note : the first modification begins the list.
647 ListOfDates GetModificationsDate();
648 const string GetModificationsDate__doc__ = "Returns the list of modification dates (without creation date) with format DD/MM/YYYY HH:MM.";
649 /*! \brief Object conversion.
651 Converts an object into IOR.
654 string ConvertObjectToIOR(in Object theObject);
655 const string ConvertObjectToIOR__doc__ = "Converts an object into IOR.";
656 /*! \brief Object conversion.
658 Converts IOR into an object.
661 Object ConvertIORToObject(in string theIOR);
662 const string ConvertIORToObject__doc__ = "Converts IOR into an object.";
664 Gets a new %UseCaseBuilder.
666 UseCaseBuilder GetUseCaseBuilder();
667 const string GetUseCaseBuilder__doc__ = "Gets a new UseCaseBuilder.";
670 Closes the components in the study, removes itself from the %StudyManager.
673 const string Close__doc__ = "Closes the components in the study, removes itself from the StudyManager.";
676 Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case.
678 void EnableUseCaseAutoFilling(in boolean isEnabled);
679 const string EnableUseCaseAutoFilling__doc__ = "Enables(if isEnabled = True)/disables automatic addition of new SObjects to the use case.";
681 const string Study__doc__ = "The Study interface contains a set of mrthods used for management of \nthe data produced by various components of SALOME platform.";
683 //==========================================================================
684 /*! \brief %Study Builder Interface
686 The purpose of the Builder is to add and/or remove objects and attributes.
687 A %StudyBuilder is linked to a %Study. A
688 command management is provided for the undo/redo functionalities.
690 <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
691 item's position in the tree-type structure of the browser. In general it has the following
692 form: <TT>0:2:1:1</TT>
694 //==========================================================================
696 interface StudyBuilder
698 /*! \brief %LockProtection Exception
700 This exception is raised while attempting to modify a locked %study.
702 exception LockProtection {};
703 /*! \brief Creation of a new %SComponent.
705 Creates a new %SComponent
706 \param ComponentDataType Data type of the %SComponent which will be created.
708 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
711 SComponent NewComponent(in string ComponentDataType);
712 const string NewComponent__doc__ = "Creates a new SComponent.";
713 /*! \brief Definition of the instance to the %SComponent
715 Defines the instance to the %SComponent.
717 void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR);
718 const string DefineComponentInstance__doc__ = "Defines the instance to the SComponent.";
719 /*! \brief Deletion of the %SComponent
721 Removes the %SComponent.
723 void RemoveComponent(in SComponent aComponent);
724 const string RemoveComponent__doc__ = "Removes the SComponent.";
726 /*! \brief Creation of a new %SObject
728 Creates a new %SObject.
729 <BR><VAR>See also <A href=exemple/Example18.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
732 SObject NewObject (in SObject theFatherObject);
733 const string NewObject__doc__ = "Creates a new SObject.";
734 /*! \brief Creation of a new %SObject with a definite %tag
736 Creates a new %SObject with a definite %tag.
738 SObject NewObjectToTag (in SObject theFatherObject, in long atag);
739 const string NewObjectToTag__doc__ = "Creates a new SObject with a definite tag.";
740 /*! \brief Deletion of the %SObject
742 Removes a %SObject from the %StudyBuilder.
744 void RemoveObject (in SObject anObject);
745 const string RemoveObject__doc__ = "Removes a SObject from the StudyBuilder.";
746 /*! \brief Deletion of the %SObject with all his child objects.
748 Removes the %SObject with all his child objects.
750 void RemoveObjectWithChildren(in SObject anObject);
751 const string RemoveObjectWithChildren__doc__ = "Removes the SObject with all his child objects.";
755 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
758 void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
759 const string LoadWith__doc__ = "Loads a SComponent.";
763 void Load (in SObject sco);
764 const string Load__doc__ = "Loads a SObject.";
766 /*! \brief Looking for or creating an attribute assigned to the %SObject
768 Allows to find or create an attribute of a specific type which is assigned to the object.
769 \param anObject The %SObject corresponding to the attribute which is looked for.
770 \param aTypeOfAttribute Type of the attribute.
772 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
775 GenericAttribute FindOrCreateAttribute(in SObject anObject,
776 in string aTypeOfAttribute);
777 const string FindOrCreateAttribute__doc__ = "Allows to find or create an attribute of a specific type which is assigned to the object.";
779 /*! \brief Looking for an attribute assigned to %SObject
781 Allows to find an attribute of a specific type which is assigned to the object.
782 \param anObject The %SObject corresponding to the attribute which is looked for.
783 \param aTypeOfAttribute Type of the attribute.
784 \param anAttribute Where the attribute is placed if it's found.
785 \return True if it finds an attribute.
788 boolean FindAttribute(in SObject anObject,
789 out GenericAttribute anAttribute,
790 in string aTypeOfAttribute);
791 const string FindAttribute__doc__ = "Allows to find an attribute of a specific type which is assigned to the object.";
792 /*! \brief Deleting the attribute assigned to the %SObject
794 Removes the attribute of a specific type which is assigned to the object.
795 \param anObject The %SObject corresponding to the attribute.
796 \param aTypeOfAttribute Type of the attribute.
798 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
800 void RemoveAttribute(in SObject anObject,
801 in string aTypeOfAttribute);
802 const string RemoveAttribute__doc__ = "Removes the attribute of a specific type which is assigned to the object.";
803 /*! \brief Addition of a reference
805 Adds a reference between %anObject and %theReferencedObject.
808 void Addreference(in SObject anObject,
809 in SObject theReferencedObject) ;
810 const string Addreference__doc__ = "Adds a reference between anObject and theReferencedObject.";
812 Adds a directory in the %Study.
813 <BR><VAR>See also <A href=exemple/Example23.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
816 void AddDirectory(in string theName);
817 const string AddDirectory__doc__ = "Adds a directory in the Study.";
819 /*! \brief Identification of the %SObject's substructure.
821 Identification of the %SObject's substructure by GUID.
822 It has the following format "00000000-0000-0000-0000-000000000000"
825 void SetGUID(in SObject anObject, in string theGUID);
826 const string SetGUID__doc__ = "Identification of the %SObject's substructure by GUID. \nIt has the following format: 00000000-0000-0000-0000-000000000000.";
829 Returns True if the %SObject has GUID.
831 boolean IsGUID(in SObject anObject, in string theGUID);
832 const string IsGUID__doc__ = "Returns True if the SObject has GUID.";
834 /*! \brief Creation of a new command
836 Creates a new command which can contain several different actions.
837 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
840 void NewCommand(); // command management
841 const string NewCommand__doc__ = "Creates a new command which can contain several different actions.";
842 /*! \brief Execution of the command
844 Commits all actions declared within this command.
845 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
848 void CommitCommand() raises(LockProtection); // command management
849 const string CommitCommand__doc__ = "Commits all actions declared within this command.";
851 Returns True if at this moment there is a command under execution.
853 boolean HasOpenCommand();
854 const string HasOpenCommand__doc__ = "Returns True if at this moment there is a command under execution.";
855 /*! \brief Cancelation of the command
857 Cancels all actions declared within the command.
858 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
860 void AbortCommand(); // command management
861 const string AbortCommand__doc__ = "Cancels all actions declared within the command.";
864 The number of actions which can be undone
866 attribute long UndoLimit;
867 /*! \brief Undo method
869 Cancels all actions of the last command.
870 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
873 void Undo() raises (LockProtection);
874 const string Undo__doc__ = "Cancels all actions of the last command.";
875 /*! \brief Redo method
877 Redoes all actions of the last command.
878 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
881 void Redo() raises (LockProtection);
882 const string Redo__doc__ = "Redoes all actions of the last command.";
884 Returns True if at this moment there are any actions which can be canceled.
885 <BR><VAR>See also <A href=exemple/Example16.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
888 boolean GetAvailableUndos();
889 const string GetAvailableUndos__doc__ = "Returns True if at this moment there are any actions which can be canceled.";
891 Returns True if at this moment there are any actions which can be redone.
892 <BR><VAR>See also <A href=exemple/Example3.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
895 boolean GetAvailableRedos();
896 const string GetAvailableRedos__doc__ = "Returns True if at this moment there are any actions which can be redone.";
898 Sets the callback for addition of the given %SObject. Returns the previous callback.
900 Callback SetOnAddSObject(in Callback theCallback);
901 const string SetOnAddSObject__doc__ = "Sets the callback for addition of the given SObject.";
903 Sets the callback for removal of the given %SObject. Returns the previous callback.
905 Callback SetOnRemoveSObject(in Callback theCallback);
906 const string SetOnRemoveSObject__doc__ = " Sets the callback for removal of the given SObject.";
909 const string StudyBuilder__doc__ = "The Study Builder Interface contains a set of methods used for adding and/or removing objects and attributes.";
911 //==========================================================================
912 /*! \brief %Study Manager interface
914 The purpose of the Manager is to manipulate the %Studies. You will find in this
915 interface the methods to create, open,
916 close, and save a %Study. Since a %SALOME session is multi-document, you will
917 also find the methods allowing to navigate
918 through the collection of studies present in a session.
920 //==========================================================================
922 interface StudyManager
925 Determines whether the server has already been loaded or not.
928 const string ping__doc__ = "Determines whether the server has already been loaded or not.";
930 /*! \brief Creation of a new %Study
932 Creates a new %Study with a definite name.
933 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
936 Study NewStudy(in string study_name);
937 const string NewStudy__doc__ = "Creates a new study with a definite name.";
939 /*! \brief Open a study
941 Reads and activates the structure of the study %Objects.
942 \warning This method doesn't activate the corba objects. Only a component can do it.
943 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
945 Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
946 const string Open__doc__ = "Reads and activates the structure of the study objects.";
948 /*! \brief Closing the study
952 void Close(in Study aStudy);
953 const string Close__doc__ = "Closes the study.";
954 /*! \brief Saving the study
957 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
960 void Save(in Study aStudy, in boolean theMultiFile);
961 const string Save__doc__ = "Saves the study.";
962 /*! \brief Saving the study in a file
964 Saves the study in a specified file.
965 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
967 void SaveAs(in URL aUrl, // if the file already exists
969 in boolean theMultiFile); // overwrite (as option)
970 const string SaveAs__doc__ = "Saves the study in a specified file.";
971 /*! \brief List of open studies.
973 Returns the list of open studies in the current session.
975 ListOfOpenStudies GetOpenStudies();
976 const string GetOpenStudies__doc__ = "Returns the list of open studies in the current session.";
978 /*! \brief Getting a particular %Study picked by name
980 Activates a particular %Study
981 amongst the session collection picking it by name.
983 Study GetStudyByName (in string aStudyName);
984 const string GetStudyByName__doc__ = "Activates a particular study amongst the session collection picking it by name.";
986 /*! \brief Getting a particular %Study picked by ID
988 Activates a particular %Study
989 amongst the session collection picking it by ID.
991 Study GetStudyByID (in short aStudyID);
992 const string GetStudyByID__doc__ = "Activates a particular study amongst the session collection picking it by ID.";
994 // copy/paste methods
997 Returns True, if the given %SObject can be copied to the clipboard.
999 boolean CanCopy(in SObject theObject);
1000 const string CanCopy__doc__ = "Returns True, if the given SObject can be copied to the clipboard.";
1002 Returns True, if the given %SObject is copied to the clipboard.
1004 boolean Copy(in SObject theObject);
1005 const string Copy__doc__ = "Returns True, if the given SObject is copied to the clipboard.";
1007 Returns True, if the object from the clipboard can be pasted to the given %SObject.
1009 boolean CanPaste(in SObject theObject);
1010 const string CanPaste__doc__ = "Returns True, if the object from the clipboard can be pasted to the given SObject.";
1012 Returns the %SObject in which the object from the clipboard was pasted to.
1014 SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
1015 const string Paste__doc__ = "Returns the SObject in which the object from the clipboard was pasted to.";
1017 const string StudyManager__doc__ = "The purpose of the Manager is to manipulate the studies. \nThe StudyManager interface contains a set of methods to create, open,close and save a study.";
1020 //==========================================================================
1021 /*! \brief %SObject interface
1023 The objects in the %study are built by the %StudyBuilder. The %SObject interface
1024 provides methods for elementary inquiries, like getting an object %ID or its attribuites.
1026 <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
1027 in the tree-type data structure.
1028 <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
1029 ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
1031 //==========================================================================
1035 /*! Name of the %SObject
1037 attribute string Name; // equivalent to setName() & getName()
1038 /*! \brief Getting an object %ID
1040 Returns ID of the %SObject.
1043 const string GetID__doc__ = "Returns ID of the SObject.";
1044 /*! \brief Acquisition of the father %Component of the %SObject
1046 Returns the father %Component of the %SObject.
1048 SComponent GetFatherComponent();
1049 const string GetFatherComponent__doc__ = "Returns the father Component of the SObject.";
1050 /*! \brief Acquisition of the father %SObject of the %SObject
1052 Returns the father %SObject of the given %SObject.
1054 SObject GetFather();
1055 const string GetFather__doc__ = "Returns the father SObject of the given SObject.";
1056 /*! \brief %Tag of %SObject
1058 Returns the %tag of the %SObject.
1061 const string Tag__doc__ = "Returns the tag of the SObject.";
1062 /*! \brief Looking for subobjects of an object.
1064 Returns True if it finds a subobject of the %SObject with a definite tag.
1067 boolean FindSubObject (in long atag, out SObject obj);
1068 const string FindSubObject__doc__ = "Returns True if it finds a subobject of the SObject with a definite tag.";
1069 /*! \brief Looking for attributes of the %SObject
1071 Returns True if it finds an attribute of a definite type of the %SObject.
1072 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1074 boolean FindAttribute(out GenericAttribute anAttribute,
1075 in string aTypeOfAttribute);
1076 const string FindAttribute__doc__ = "Returns True if it finds an attribute of a definite type of the given SObject.";
1078 Returns the object which this %SObject refers to. It also returns True if it finds
1081 boolean ReferencedObject(out SObject obj); // A REVOIR
1082 const string ReferencedObject__doc__ = "Returns the object which this given SObject refers to. \nIt also returns True if it finds this object.";
1083 /*! \brief Getting all attributes of the %SObject
1085 Returns the list of all attributes of the %SObject.
1086 <BR><VAR>See also <A href=exemple/Example17.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1089 ListOfAttributes GetAllAttributes();
1090 const string GetAllAttributes__doc__ = "Returns the list of all attributes of the given SObject.";
1091 /*! \brief Returning the study
1093 Returns the study containing the given %SObject.
1096 const string GetStudy__doc__ = "Returns the study containing the given SObject.";
1098 const string SObject__doc__ = "The objects in the study are built by the StudyBuilder. \nThe SObject interface provides methods for elementary inquiries, \nlike getting an object ID or its attribuites.";
1101 //==========================================================================
1102 /*! \brief %Generic attribute interface
1104 %Generic attribute is a base interface for all attributes which inherit
1107 //==========================================================================
1108 interface GenericAttribute
1110 /*! \brief Exception locking all changes
1112 This exception locks all modifications in attributes.
1114 exception LockProtection {};
1115 /*! \brief Method CheckLocked
1117 Checks whether the %Study is protected for modifications.
1118 \note <BR>This exception is raised only outside the transaction.
1120 void CheckLocked() raises (LockProtection);
1121 const string CheckLocked__doc__ = "Checks whether the study is protected for modifications.";
1123 const string GenericAttribute__doc__ = "GenericAttribute is a base interface for all attributes which inherit its methods.";
1127 //==========================================================================
1128 /*! \brief %SComponent interface
1130 The %SComponent interface is a specialization of the %SObject interface.
1131 It inherits the most of its methods from the %SObject interface.
1133 //==========================================================================
1134 interface SComponent : SObject
1136 /*! \brief Data type of the %SComponent
1138 Returns the data type of the %SComponent.
1140 string ComponentDataType();
1141 const string ComponentDataType__doc__ = "Returns the data type of the SComponent.";
1143 Returns IOR of the according component.
1145 boolean ComponentIOR (out ID theID); //returns True if there is an instance
1146 //In this case ID identifies this one
1147 const string ComponentIOR__doc__ = "Returns IOR of the according component.";
1149 const string SComponent__doc__ = "The SComponent interface is a specialization of the SObject interface. \nIt inherits the most of its methods from the SObject interface.";
1152 //==========================================================================
1153 /*! \brief %SComponentIterator interface
1155 This interface contains the methods allowing to iterate over all components in the list.
1156 The search is started from the first %SComponent in the list.
1158 //==========================================================================
1159 interface SComponentIterator
1161 /*! \brief Initialization of the Iterator
1163 Activates the %SComponentIterator.
1166 const string Init__doc__ = "Activates the SComponentIterator.";
1167 /*! \brief Method More
1169 Returns True if there is one more %SComponent in the list.
1172 const string More__doc__ = "Returns True if there is one more SComponent in the list.";
1173 /*! \brief Moving the iterator to the next %SComponent
1175 Moves the iterator to the next %SComponent in the list.
1178 const string Next__doc__ = "Moves the iterator to the next SComponent in the list.";
1180 Returns the %SComponent corresponding to the current %SComponent found by the iterator.
1181 <BR><VAR>See also <A href=exemple/Example1.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1185 const string Value__doc__ = "Returns the SComponent corresponding to the current SComponent found by the iterator.";
1187 const string SComponentIterator__doc__ = "This interface contains the methods allowing to iterate over all components in the list. \nThe search is started from the first SComponent in the list.";
1189 //==========================================================================
1190 /*! \brief %ChildIterator interface
1192 This interface contains methods which allow to iterate over all child
1195 //==========================================================================
1196 interface ChildIterator
1198 /*! \brief Initialization of the Iterator.
1200 Activates the %ChildIterator.
1203 const string Init__doc__ = "Activates the ChildIterator.";
1204 /*! \brief Initialization of the Iterator for all child levels.
1206 Activates the %ChildIterator (if True) for all child levels.
1208 void InitEx(in boolean allLevels);
1209 const string InitEx__doc__ = "Activates the ChildIterator (if True) for all child levels.";
1210 /*! \brief Method More
1212 Returns True if the %ChildIterator finds one more child level.
1215 const string More__doc__ = "Returns True if the ChildIterator finds one more child level.";
1217 Passes the iterator to the next level.
1220 const string Next__doc__ = "Passes the iterator to the next level.";
1222 Returns the %SObject corresponding to the current object found by the iterator.
1225 const string Value__doc__ = "Returns the SObject corresponding to the current object found by the iterator.";
1227 const string ChildIterator__doc__ = "This interface contains methods which allow to iterate over all child levels.";
1229 //==========================================================================
1230 //==========================================================================
1231 /*! \brief Interface of the %UseCaseIterator.
1233 This interface contains a set of methods used for iteration over the objects in the use case.
1235 interface UseCaseIterator
1237 /*! \brief Initialization of the Iterator.
1239 Activates the %UseCaseIterator. If <VAR>allLevels</VAR> is True the Iterator is activated for all subobjects.
1241 void Init(in boolean allLevels);
1242 const string Init__doc__ = "Activates the UseCaseIterator. \nIf the value of the parameter allLevels is True the Iterator is activated for all subobjects.";
1243 /*! \brief Method More
1245 Returns True if the %UseCaseIterator finds one more object.
1248 const string More__doc__ = "Returns True if the UseCaseIterator finds one more object.";
1250 Passes the iterator to the next object.
1253 const string Next__doc__ = "Passes the iterator to the next object.";
1255 Returns the %SObject corresponding to the current object found by the Iterator.
1258 const string Value__doc__ = "Returns the SObject corresponding to the current object found by the Iterator.";
1260 const string UseCaseIterator__doc__ = "This interface contains a set of methods used for \niteration over the objects in the use case.";
1262 //==========================================================================
1263 //==========================================================================
1264 /*! \brief Interface of the %UseCaseBuilder
1266 Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1267 The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1269 interface UseCaseBuilder
1272 Adds to the use case an object <VAR>theObject</VAR> as a child of the current object of the use case.
1274 boolean Append(in SObject theObject);
1275 const string Append__doc__ = "Adds to the use case an object as a child of the current object of the use case.";
1277 Removes an object <VAR>theObject</VAR> from the use case.
1279 boolean Remove(in SObject theObject);
1280 const string Remove__doc__ = "Removes an object from the use case.";
1282 Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1284 boolean AppendTo(in SObject theFather, in SObject theObject);
1285 const string AppendTo__doc__ = "Adds a child object to the given father object in the use case.";
1287 Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1289 boolean InsertBefore(in SObject theFirst, in SObject theNext);
1290 const string InsertBefore__doc__ = "Inserts in the use case an object before another object.";
1292 Sets the current object of the use case.
1294 boolean SetCurrentObject(in SObject theObject);
1295 const string SetCurrentObject__doc__ = "Sets the current object of the use case.";
1297 Makes the root object to be the current object of the use case.
1299 boolean SetRootCurrent();
1300 const string SetRootCurrent__doc__ = "Makes the root object to be the current object of the use case.";
1302 Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1304 boolean HasChildren(in SObject theObject);
1305 const string HasChildren__doc__ = "Returns True if the given object of the use case has child objects.";
1307 Sets the name of the use case.
1309 boolean SetName(in string theName);
1310 const string SetName__doc__ = "Sets the name of the use case.";
1312 Gets the name of the use case.
1315 const string GetName__doc__ = "Gets the name of the use case.";
1317 Returns True if the given object <VAR>theObject</VAR> represents a use case.
1319 boolean IsUseCase(in SObject theObject);
1320 const string IsUseCase__doc__ = "Returns True if the given object represents a use case.";
1322 Gets the current object of the use case.
1324 SObject GetCurrentObject();
1325 const string GetCurrentObject__doc__ = "Gets the current object of the use case.";
1327 Creates a new use case in the use case browser.
1329 SObject AddUseCase(in string theName);
1330 const string AddUseCase__doc__ = "Creates a new use case in the use case browser.";
1332 Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1334 UseCaseIterator GetUseCaseIterator(in SObject theObject);
1335 const string GetUseCaseIterator__doc__ = "Returns the UseCaseIterator for the given object in the use case.";
1337 const string UseCaseBuilder__doc__ = "The UseCaseBuilder interface contains a set of methods \nused for management of the use case in the study.";
1338 //==========================================================================
1339 //==========================================================================
1340 /*! \brief The callback interface
1342 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
1343 and this object is assigned to the newly created Builder as callback which should be called when adding and removing of the ojects.
1348 Invokes the corresponding method <VAR>Append</VAR> of the %UseCaseBuilder.
1350 void OnAddSObject(in SObject theObject);
1351 const string OnAddSObject__doc__ = "Invokes the corresponding method Append of the UseCaseBuilder.";
1353 Invokes the corresponding method <VAR>Remove</VAR> of the %UseCaseBuilder.
1355 void OnRemoveSObject(in SObject theObject);
1356 const string OnRemoveSObject__doc__ = "Invokes the corresponding method Remove of the UseCaseBuilder.";
1358 const string Callback__doc__ = "The callback interface contains a set of methods which are called \nwhen adding or removing of the objects by the StudyBuilder.";
1360 //==========================================================================
1361 /*! \brief %Driver interface
1363 This interface contains a set of methods used for the management
1364 of the object produced in the %study by a component.
1366 //==========================================================================
1370 /*! \brief Saving the data.
1372 This method is called by the StudyManager when saving a study.
1373 \param theComponent %SComponent corresponding to this Component
1374 \return A byte stream TMPFile that contains all saved data
1376 <BR><VAR>See also <A href=exemple/Example19.html> an example </A> of this method usage in batchmode of %SALOME application.</VAR>
1381 TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1382 const string Save__doc__ = "This method is called by the StudyManager when saving a study.";
1385 /*! \brief Loading the data.
1387 This method is called by the StudyManager when opening a study.
1388 \param theComponent %SComponent corresponding to this Component
1389 \param theStream The file which contains all data saved by the component on Save method
1392 boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1393 const string Load__doc__ = "This method is called by the StudyManager when opening a study.";
1396 /*! \brief Closing of the study
1398 This method Close is called by the StudyManager when closing a study.
1402 void Close (in SComponent aSComponent);
1403 const string Close__doc__ = "This method Close is called by the StudyManager when closing a study.";
1404 //void Close ( in string aIORSComponent);
1406 /*! \brief The type of the data
1408 Returns the type of data produced by the Component in the study.
1411 string ComponentDataType();
1412 const string ComponentDataType__doc__ = "Returns the type of data produced by the Component in the study.";
1414 // Driver Transient -> persistent called for each object in study
1416 Transforms IOR into PersistentID of the object. It is called for each
1417 object in the %study.
1419 string IORToLocalPersistentID (in SObject theSObject, in string IORString, in boolean isMultiFile);
1420 const string IORToLocalPersistentID__doc__ = "Transforms IOR into PersistentID of the object.";
1422 Transforms PersistentID into IOR of the object. It is called for each
1423 object in the %study.
1425 string LocalPersistentIDToIOR (in SObject theSObject, in string aLocalPersistentID, in boolean isMultiFile)
1426 raises (SALOME::SALOME_Exception);
1427 const string LocalPersistentIDToIOR__doc__ = "Transforms PersistentID into IOR of the object.";
1429 // Publishing in the study
1430 /*! \brief Publishing in the study
1432 Returns True if the given %Component can publish the %object in the %study.
1434 boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1435 const string CanPublishInStudy__doc__ = "Returns True if the given Component can publish the object in the study.";
1436 /*! \brief Publishing in the study
1438 Publishes the given object in the %study, using the algorithm of this component.
1439 \param theStudy The %study in which the object is published
1440 \param theSObject If this parameter is null the object is published for the first time. Otherwise
1441 this parameter should contain a reference to the object published earlier
1442 \param theObject The object which is published
1443 \param theName The name of the published object. If this parameter is empty, the name is generated
1444 automatically by the component.
1446 SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
1447 const string PublishInStudy__doc__ = "Publishes the given object in the study, using the algorithm of this component.";
1449 // copy/paste methods
1452 Returns True, if the given %SObject can be copied to the clipboard.
1454 boolean CanCopy(in SObject theObject);
1455 const string CanCopy__doc__ = "Returns True, if the given SObject can be copied to the clipboard.";
1457 Returns the object %ID and the %TMPFile of the object from the given %SObject.
1459 TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1460 const string CopyFrom__doc__ = "Returns the object ID and the TMPFile of the object from the given SObject.";
1462 Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1464 boolean CanPaste(in string theComponentName, in long theObjectID);
1465 const string CanPaste__doc__ = "Returns True, if the component can paste the object with given ID of the component with name <VAR>theComponentName</VAR>.";
1467 Returns the %SObject of the pasted object.
1469 SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);
1470 const string PasteInto__doc__ = "Returns the SObject of the pasted object.";
1473 const string Driver__doc__ = "This interface contains a set of methods used for the management \nof the object produced in the study by a component.";