idl/SALOMEDS.idl

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : SALOMEDS.idl
  24 //  Author : Yves FRICAUD
  25 //
  26 /*!  \file SALOMEDS.idl  \brief This file contains a set of interfaces used for creation, management
  27   and modification of the %Study
  28 */
  29
  30 #ifndef _SALOMEDS_IDL_
  31 #define _SALOMEDS_IDL_
  32
  33 #include "SALOME_Exception.idl"
  34 #include "SALOME_GenericObj.idl"
  35
  36 /*! \brief
  37      This package contains the interfaces used for creation, management
  38      and modification of the %Study
  39 */
  40 module SALOMEDS
  41 {
  42 /*! \brief Name of the file in which the %Study is saved.
  43 */
  44   typedef string URLPath;
  45
  46 /*! \brief Main identifier of an object in %SALOME application
  47 */
  48   typedef string ID;
  49
  50 /*! \brief While saving the data, IOR is transformed into persistent reference
  51 */
  52   typedef string PersistentReference;
  53
  54 /*! \brief IOR of the study in %SALOME application
  55 */
  56   typedef string SalomeReference;
  57
  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;
  66
  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
  73
  74   interface GenericAttribute;
  75   interface Study;
  76   interface StudyBuilder;
  77   interface SObject;
  78   interface SComponent;
  79   interface SComponentIterator;
  80   interface ChildIterator;
  81   interface Driver;
  82   interface AttributeStudyProperties;
  83   interface AttributeParameter;
  84   interface UseCaseIterator;
  85   interface UseCaseBuilder;
  86
  87   interface Observer
  88   {
  89     oneway void notifyObserverID(in string theID, in long event);
  90   };
  91
  92
  93 //! List of attributes of %SObjects
  94   typedef sequence<GenericAttribute> ListOfAttributes;
  95
  96 //! Exception indicating that this feature hasn't been implemented in %SALOME application.
  97   exception NotImplemented {};
  98
  99   //==========================================================================
 100 /*! \brief %Study Builder Interface
 101
 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.
 105   \note
 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>
 109 */
 110   //==========================================================================
 111
 112   interface StudyBuilder
 113   {
 114 /*! \brief %LockProtection Exception
 115
 116     This exception is raised while attempting to modify a locked %study.
 117 */
 118     exception LockProtection {};
 119 /*! \brief Creation of a new %SComponent.
 120
 121    Creates a new %SComponent
 122    \param ComponentDataType    Data type of the %SComponent which will be created.
 123
 124 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 125
 126 */
 127     SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
 128 /*! \brief Definition of the instance to the %SComponent
 129
 130     Defines the instance to the %SComponent.
 131 */
 132     void       DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
 133
 134 /*! \brief Deletion of a %SComponent
 135
 136   Removes a %SComponent.
 137 */
 138     void       RemoveComponent(in SComponent aComponent) raises(LockProtection);
 139
 140 /*! \brief Creation of a new %SObject
 141
 142    Creates a new %SObject under a definite father %SObject.
 143
 144    \param theFatherObject The father %SObject under which this one should be created.
 145    \return New %SObject
 146
 147 <em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
 148
 149 */
 150
 151     SObject NewObject      (in SObject theFatherObject) raises(LockProtection);
 152
 153 /*! \brief Creation of a new %SObject with a definite %tag
 154
 155    Creates a new %SObject with a definite %tag.
 156
 157    \param atag Long value corresponding to the tag of the new %SObject.
 158    \return New %SObject
 159
 160 */
 161     SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
 162 /*! \brief Deletion of the %SObject
 163
 164   Removes a %SObject from the %StudyBuilder.
 165
 166   \param anObject The %SObject to be deleted.
 167 */
 168     void    RemoveObject   (in SObject anObject) raises(LockProtection);
 169 /*! \brief Deletion of the %SObject with all his child objects.
 170
 171   Removes the %SObject with all his child objects.
 172
 173   \param anObject The %SObject to be deleted with all child objects.
 174 */
 175     void    RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
 176
 177 /*!
 178    Loads a %SComponent.
 179
 180 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
 181
 182 */
 183     void  LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
 184 /*!
 185    Loads a %SObject.
 186
 187    \param sco %SObject to be loaded.
 188 */
 189     void  Load (in SObject sco);
 190
 191 /*! \brief Looking for or creating an attribute assigned to the %SObject
 192
 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.
 196
 197 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
 198 */
 199
 200     GenericAttribute FindOrCreateAttribute(in  SObject        anObject,
 201                                          in  string         aTypeOfAttribute) raises(LockProtection);
 202
 203 /*! \brief Looking for an attribute assigned to a %SObject
 204
 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.
 210  */
 211
 212     boolean FindAttribute(in  SObject        anObject,
 213                                  out GenericAttribute anAttribute,
 214                                  in  string         aTypeOfAttribute);
 215 /*! \brief Deleting the attribute assigned to the %SObject
 216
 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.
 220
 221 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 222 */
 223     void RemoveAttribute(in  SObject        anObject,
 224                          in  string         aTypeOfAttribute) raises(LockProtection);
 225 /*!
 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
 229 */
 230
 231     void Addreference(in SObject anObject,
 232                       in SObject theReferencedObject) ;
 233
 234 /*!
 235     Removes a reference from %anObject to another object.
 236     \param anObject The %SObject which contains a reference
 237 */
 238
 239     void RemoveReference(in SObject anObject) ;
 240
 241 /*!
 242    Adds a directory in the %Study.
 243    \param theName String parameter defining the name of the directory.
 244
 245 <em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
 246
 247 */
 248     void AddDirectory(in string theName) raises(LockProtection);
 249
 250 /*! \brief Identification of the %SObject's substructure.
 251
 252       Identification of the %SObject's substructure by GUID.
 253
 254
 255       \param anObject The %SObject which will be identified
 256       \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
 257 */
 258
 259      void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
 260 /*!
 261 Searches for a definite %SObject with a definite GUID and returns True if it finds it.
 262
 263 \param anObject A definite %SObject which will be identified
 264 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
 265 */
 266      boolean IsGUID(in SObject anObject, in string theGUID);
 267
 268 /*! \brief Creation of a new command
 269
 270    Creates a new command which can contain several different actions.
 271
 272 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
 273
 274 */
 275     void NewCommand(); // command management
 276 /*! \brief Execution of the command
 277
 278    Commits all actions declared within this command.
 279
 280    \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
 281
 282 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 283
 284 */
 285     void CommitCommand() raises(LockProtection); // command management
 286 /*!
 287     Returns True if at this moment there is a command under execution.
 288 */
 289     boolean HasOpenCommand();
 290 /*! \brief Cancelation of the command
 291
 292     Cancels all actions declared within the command.
 293
 294 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 295 */
 296     void AbortCommand(); // command management
 297 /*! \brief Undolimit
 298
 299     The number of actions which can be undone
 300 */
 301     attribute long  UndoLimit;
 302 /*! \brief Undo method
 303
 304     Cancels all actions of the last command.
 305
 306     \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
 307
 308 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 309
 310 */
 311     void Undo() raises (LockProtection);
 312 /*! \brief Redo method
 313
 314     Redoes all actions of the last command.
 315
 316 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
 317
 318 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 319
 320 */
 321     void Redo() raises (LockProtection);
 322 /*!
 323     Returns True if at this moment there are any actions which can be canceled.
 324
 325 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 326
 327 */
 328     boolean GetAvailableUndos();
 329 /*!
 330     Returns True if at this moment there are any actions which can be redone.
 331
 332 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
 333
 334 */
 335     boolean GetAvailableRedos();
 336 /*!
 337     Puts name attribute with the given string value to the given %SObject
 338
 339     \param theSO Existing SObject to set name attribute.
 340     \param theValue The value to be set to the name attribute.
 341 */
 342     void SetName(in SObject theSO, in string theValue) raises (LockProtection);
 343
 344 /*!
 345     Puts comment attribute with the given string value to the given %SObject
 346
 347     \param theSO Existing SObject to set comment attribute.
 348     \param theValue The value to be set to the comment attribute.
 349 */
 350     void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
 351
 352 /*!
 353     Puts IOR attribute with the given string value to the given %SObject
 354
 355     \param theSO Existing SObject to set IOR attribute.
 356     \param theValue The value to be set to the IOR attribute.
 357 */
 358     void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
 359   };
 360
 361   //===========================================================================
 362  /*! \brief %Study Interface
 363
 364     The purpose of the %Study is to manage the data produced by various components of %SALOME platform.
 365    Most of the %Study operations are handled by the StudyBuilder.
 366    What is left in the %Study interface are elementary inquiries.
 367    (Incidentally, we recall that a CORBA attribute is implemented as a pair of get
 368       and set methods.) A %Study is explored by a set of tools, mainly iterators
 369     , which are described further. Nevertheless, the %Study
 370      interface allows the search of an object by name or by ID.
 371      \note
 372      <BR><VAR>The Path </VAR>of an object in %SALOME application is much alike a standard path of a file.
 373     In general it's a string of names of directories divided by a slash '/'.
 374      <BR><VAR>The Context</VAR> is the current directory of an object.</P>
 375 */
 376
 377   interface Study
 378   {
 379
 380 //! Invalid study reference
 381     exception StudyInvalidReference {};
 382 //! Invalid study context
 383     exception StudyInvalidContext {};
 384 //! Invalid study component
 385     exception StudyInvalidComponent {};
 386 //! Invalid directory of the %study exception
 387     exception StudyInvalidDirectory {};
 388 //! Exception pointing that this name of the study has already been used.
 389     exception StudyNameAlreadyUsed {};
 390 //! study object already exists
 391     exception StudyObjectAlreadyExists {};
 392 //! Invalid name of the %study exception
 393     exception StudyNameError {};
 394 //! Invalid study comment
 395     exception StudyCommentError {};
 396
 397 /*!
 398     Determines whether the server has already been loaded or not.
 399 */
 400     void ping();
 401     void Shutdown();
 402 /*!
 403     Returns the PID of the server
 404 */
 405     long getPID();
 406
 407 /*!
 408     Shutdown the Study process.
 409 */
 410     oneway void ShutdownWithExit();
 411
 412 /*! \brief The name of the %Study
 413
 414    This is equivalent to the methods setName() & getName()
 415 */
 416     readonly attribute string Name; // equivalent to getName()
 417
 418 //! Sequence containing %SObjects
 419     typedef sequence<SObject> ListOfSObject;
 420 //!  Get the persistent reference to the %Study.
 421     PersistentReference  GetPersistentReference() raises(StudyInvalidReference);
 422 //! Get a transient reference to the %Study.
 423     SalomeReference      GetTransientReference() raises(StudyInvalidReference);
 424
 425 /*! \brief indicate whether the %Study is empty
 426
 427     \return True if the %Study is empty
 428 */
 429     boolean IsEmpty() raises(StudyInvalidReference);
 430 /*! \brief  Find a %SComponent by its name.
 431
 432    \param aComponentName    It's a string value in the Comment Attribute of the Component,
 433     which is looked for, defining the data type of this Component.
 434
 435 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
 436
 437 */
 438     SComponent FindComponent  (in string aComponentName) raises(StudyInvalidReference);
 439
 440 /*! \brief  Find a %SComponent by ID of the according %SObject
 441 */
 442     SComponent FindComponentID(in ID aComponentID) raises(StudyInvalidReference);
 443 /*! \brief  Find a %SObject by the Name Attribute of this %SObject
 444
 445     \param anObjectName String parameter defining the name of the object
 446     \return The obtained %SObject
 447
 448 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
 449 */
 450     SObject       FindObject      (in string anObjectName) raises(StudyInvalidReference);
 451 /*! \brief  Find a %SObject by its ID
 452
 453     \param aObjectID This parameter defines the ID of the required object
 454     \return The obtained %SObject
 455 */
 456     SObject       FindObjectID    (in ID aObjectID) raises(StudyInvalidReference);
 457 /*! \brief Create a %SObject by its ID
 458
 459     \param aObjectID This parameter defines the ID of the required object
 460     \return The created %SObject
 461 */
 462     SObject       CreateObjectID    (in ID aObjectID) raises(StudyInvalidReference);
 463 /*!  \brief Find a %SObject by IOR of the object belonging to this %SObject.
 464
 465     \param anObjectName This parameter defines the IOR of the object
 466     \return The obtained %SObject
 467 */
 468     SObject       FindObjectIOR   (in ID aObjectIOR) raises(StudyInvalidReference);
 469 /*! \brief  Find in the study all %SObjects produced by a given %Component.
 470
 471     \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
 472     \param aComponentName The name of the component, which objects are searched for.
 473 */
 474     ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName) raises(StudyInvalidReference);
 475 /*! \brief  Find a %SObject by the path to it.
 476
 477     \param thePath The path to the required %SObject.
 478     \return The obtained %SObject.
 479 */
 480     SObject FindObjectByPath(in string thePath) raises(StudyInvalidReference);
 481 /*! \brief Get the path to the %SObject.
 482 */
 483     string GetObjectPath(in Object theObject) raises(StudyInvalidReference);
 484
 485 /*! \brief  Set the context of the %Study.
 486
 487     \param thePath String parameter defining the context of the study.
 488
 489 <em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
 490 */
 491     void SetContext(in string thePath) raises (StudyInvalidReference, StudyInvalidContext);
 492 /*!  \brief Get the context of the %Study.
 493
 494 <em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
 495 */
 496     string GetContext() raises (StudyInvalidReference, StudyInvalidContext);
 497 /*!  \brief Get a list of names of objects corresponding to the context.
 498
 499    \note  If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
 500 */
 501     ListOfStrings GetObjectNames(in string theContext) raises (StudyInvalidReference, StudyInvalidContext);
 502 /*! \brief Get a list of names of directories and subdirectories corresponding to the context.
 503
 504    \note  If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
 505 */
 506     ListOfStrings GetDirectoryNames(in string theContext) raises (StudyInvalidReference, StudyInvalidContext);
 507 /*! \brief  Get a list of names of Files corresponding to the context.
 508
 509     \note  If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
 510 */
 511     ListOfStrings GetFileNames(in string theContext) raises (StudyInvalidReference, StudyInvalidContext);
 512 /*! \brief Get a list of names of Components corresponding to the context.
 513
 514    \note  If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
 515 */
 516     ListOfStrings GetComponentNames(in string theContext) raises(StudyInvalidReference);
 517 /*!  \brief Create a new iterator of child levels of the given %SObject.
 518
 519     \param aSO The given %SObject
 520     \return A new iterator of child levels of the given %SObject.
 521 */
 522     ChildIterator NewChildIterator(in SObject aSO) raises(StudyInvalidReference);
 523
 524 /*!  \brief Create a new iterator of the %SComponents.
 525
 526     \return A new iterator of the %SComponents.
 527 */
 528     SComponentIterator NewComponentIterator() raises(StudyInvalidReference);
 529
 530 /*! \brief  Create a new %StudyBuilder to add or modify an object in the study.
 531
 532    \return A new %StudyBuilder.
 533
 534 <em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
 535 */
 536     StudyBuilder NewBuilder() raises(StudyInvalidReference);
 537 /*! \brief Labels dependency
 538
 539     Updates the map with IOR attribute. It's an inner method used for optimization.
 540 */
 541     void UpdateIORLabelMap(in string anIOR, in string anEntry) raises(StudyInvalidReference);
 542
 543 /*! \brief Getting properties of the study
 544
 545    Returns the attribute, which contains the properties of this study.
 546
 547 <em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
 548
 549 */
 550     AttributeStudyProperties GetProperties() raises(StudyInvalidReference);
 551 /*! \brief  Indicate whether the %study has been saved
 552 */
 553     attribute boolean IsSaved;
 554 /*! \brief  Indicate whether the %study has been modified and not saved.
 555
 556   Returns True if the %study has been modified and not saved.
 557 */
 558     boolean IsModified() raises(StudyInvalidReference);
 559
 560 /*! \brief  Mark the %study as being modified and not saved.
 561 */
 562     void Modified() raises(StudyInvalidReference);
 563
 564 /*! \brief  Indicate the file where the %study has been saved
 565 */
 566     attribute string URL;
 567
 568 /*! \brief List of %SObjects
 569
 570     Returns the list of %SObjects which refers to %anObject.
 571 */
 572     ListOfSObject FindDependances(in SObject anObject) raises(StudyInvalidReference);
 573
 574 /*! \brief The date of the last saving of the study
 575
 576     Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
 577 */
 578     string GetLastModificationDate() raises(StudyInvalidReference);
 579 /*! \brief The list of modification dates of the study
 580
 581     Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
 582       Note : the first modification begins the list.
 583 */
 584     ListOfDates GetModificationsDate() raises(StudyInvalidReference);
 585 /*! \brief Object conversion.
 586
 587     Converts an object into IOR.
 588     \return    IOR
 589 */
 590     string ConvertObjectToIOR(in Object theObject);
 591 /*! \brief Object conversion.
 592
 593     Converts IOR into an object.
 594     \return    An object
 595 */
 596     Object ConvertIORToObject(in string theIOR);
 597
 598 /*! \brief Get a new %UseCaseBuilder.
 599 */
 600     UseCaseBuilder  GetUseCaseBuilder() raises(StudyInvalidReference);
 601
 602 /*! \brief Clear a study object
 603 */
 604     void Clear() raises(StudyInvalidReference);
 605
 606 /*! \brief Initialization a study object
 607 */
 608     void Init() raises(StudyInvalidReference);
 609
 610 /*! \brief Open a study by url
 611
 612     Reads and activates the structure of the study %Objects.
 613     \param aStudyUrl The path to the study
 614 */
 615     boolean Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception);
 616
 617 /*! \brief Saving the study in a HDF file (or files).
 618
 619     Saves a study.
 620     \param theMultiFile If this parameter is True the study will be saved in several files.
 621 */
 622     boolean Save(in boolean theMultiFile) raises(StudyInvalidReference);
 623
 624 /*! \brief Saving a study in a ASCII file (or files).
 625
 626     Saves a study in an ASCII format file (or files).
 627     \param theMultiFile If this parameter is True the study will be saved in several files.
 628 */
 629     boolean  SaveASCII(in boolean theMultiFile) raises(StudyInvalidReference);
 630 /*! \brief Saving the study in a specified HDF file (or files).
 631
 632     Saves the study in a specified file (or files).
 633     \param aUrl The path to the definite file in whcih the study will be saved
 634     \param aStudy The study which will be saved
 635     \param theMultiFile If this parameter is True the study will be saved in several files.
 636
 637 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
 638 */
 639     boolean  SaveAs(in URLPath aUrl, // if the file already exists
 640                     in boolean theMultiFile) // overwrite (as option)
 641                     raises(StudyInvalidReference);
 642 /*! \brief Saving the study in a specified ASCII file (or files).
 643
 644     Saves the study in a specified ASCII file (or files).
 645
 646     \param aUrl The path to the definite file in whcih the study will be saved
 647     \param aStudy The study which will be saved
 648     \param theMultiFile If this parameter is True the study will be saved in several files.
 649 */
 650     boolean  SaveAsASCII(in URLPath aUrl, // if the file already exists
 651                          in boolean theMultiFile) // overwrite (as option)
 652                          raises(StudyInvalidReference);
 653 /*!
 654     Returns True, if the given %SObject can be copied to the clipboard.
 655 */
 656     boolean CanCopy(in SObject theObject) raises(StudyInvalidReference);
 657 /*!
 658     Returns True, if the given %SObject is copied to the clipboard.
 659     \param theObject The %SObject which will be copied
 660 */
 661     boolean Copy(in SObject theObject) raises(StudyInvalidReference);
 662 /*!
 663     Returns True, if the object from the clipboard can be pasted to the given %SObject.
 664     \param theObject The %SObject stored in the clipboard.
 665 */
 666     boolean CanPaste(in SObject theObject) raises(StudyInvalidReference);
 667 /*!
 668     Returns the %SObject in which the object from the clipboard was pasted to.
 669     \param theObject The %SObject which will be pasted
 670     \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
 671     an object into a study, which is protected for modifications.
 672 */
 673     SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
 674
 675 /*! \brief  Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case.
 676 */
 677     void EnableUseCaseAutoFilling(in boolean isEnabled) raises(StudyInvalidReference);
 678
 679 /*!
 680     Functions for internal usage only
 681 */
 682     void AddPostponed(in string theIOR) raises(StudyInvalidReference);
 683
 684     void AddCreatedPostponed(in string theIOR) raises(StudyInvalidReference);
 685
 686     void RemovePostponed(in long theUndoLimit) raises(StudyInvalidReference);
 687
 688     void UndoPostponed(in long theWay) raises(StudyInvalidReference);
 689
 690     boolean DumpStudy(in string thePath,
 691                       in string theBaseName,
 692                       in boolean isPublished,
 693                       in boolean isMultiFile) raises(StudyInvalidReference);
 694
 695 /*! \brief  Get an AttributeParameter used to store common parameters for given %theSavePoint.
 696
 697     \param theID identifies a common parameters set (Example: "Interface Applicative")
 698     \param theSavePoint is number of a set of parameters as there can be several sets
 699 */
 700     AttributeParameter GetCommonParameters(in string theID, in long theSavePoint) raises(StudyInvalidReference);
 701
 702 /*! \brief  Get an AttributeParameter used to store parameters for given %theModuleName.
 703
 704     \param theID identifies a common parameters set (Example: "Interface Applicative")
 705     \param theModuleName is a name of the module (Example: "Geometry")
 706     \param theSavePoint is number of a set of parameters as there can be several sets
 707 */
 708     AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint) raises(StudyInvalidReference);
 709
 710
 711 /*! \brief Get a default Python script to restore visual parameters for given %theModuleName.
 712
 713     \param theModuleName is a name of the module (Example: "Geometry")
 714     \param indent is a string to use for script indentation
 715 */
 716     string GetDefaultScript(in string theModuleName, in string indent) raises(StudyInvalidReference);
 717
 718 /*!
 719     Private method, returns an implementation of this Study.
 720    \param theHostname is a hostname of the caller
 721    \param thePID is a process ID of the caller
 722    \param isLocal is set True if the Study is launched locally with the caller
 723 */
 724     long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
 725
 726
 727 /*! \brief  Mark this Study as being locked by the given locker.
 728
 729     The lock status can be checked by method IsStudyLocked
 730     \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that locks the study.
 731 */
 732     void SetStudyLock(in string theLockerID) raises(StudyInvalidReference);
 733
 734 /*! \brief Indicate if the Study is locked
 735
 736    Returns True if the Study was marked locked.
 737 */
 738     boolean IsStudyLocked() raises(StudyInvalidReference);
 739
 740 /*! \brief  Mark this Study as being unlocked by the given locker.
 741
 742      The lock status can be checked by method IsStudyLocked
 743     \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that unlocks the study.
 744 */
 745     void UnLockStudy(in string theLockerID) raises(StudyInvalidReference);
 746
 747 /*! \brief  Get the list of IDs of the Study's lockers.
 748 */
 749     ListOfStrings GetLockerID() raises(StudyInvalidReference);
 750
 751 /*! \brief  Create real variable with Name theVarName and value theValue
 752
 753     (or set if variable value into theValue already exists)
 754     \param theVarName is a name of the variable
 755     \param theVarName is a value of the variable.
 756 */
 757     void SetReal( in string theVarName, in double theValue ) raises(StudyInvalidReference);
 758
 759 /*! \brief  Create integer variable with Name theVarName and value theValue
 760
 761     (or set if variable value into theValue already exists)
 762     \param theVarName is a name of the variable
 763     \param theVarName is a value of the variable.
 764 */
 765     void SetInteger( in string theVarName, in long theValue ) raises(StudyInvalidReference);
 766 /*! \brief  Create boolean variable with Name theVarName and value theValue
 767
 768     (or set if variable value into theValue already exists)
 769     \param theVarName is a name of the variable
 770     \param theVarName is a value of the variable.
 771 */
 772     void SetBoolean( in string theVarName, in boolean theValue ) raises(StudyInvalidReference);
 773
 774 /*! \brief  Create string variable with Name theVarName and value theValue
 775
 776     (or set if variable value into theValue already exists)
 777     \param theVarName is a name of the variable
 778     \param theVarName is a value of the variable.
 779 */
 780     void SetString( in string theVarName, in string theValue ) raises(StudyInvalidReference);
 781
 782 /*! \brief  Set current value as double for string variable
 783 */
 784     void SetStringAsDouble( in string theVarName, in double theValue ) raises(StudyInvalidReference);
 785
 786 /*! \brief Get value of a real variable
 787
 788     \param theVarName is a name of the variable.
 789 */
 790     double GetReal( in string theVarName ) raises(StudyInvalidReference);
 791
 792 /*! \brief Get value of an integer variable
 793
 794     \param theVarName is a name of the variable.
 795 */
 796     long GetInteger( in string theVarName ) raises(StudyInvalidReference);
 797
 798 /*! \brief Get value of a boolean variable
 799
 800     \param theVarName is a name of the variable.
 801 */
 802     boolean GetBoolean( in string theVarName ) raises(StudyInvalidReference);
 803
 804 /*! \brief Get value of a string variable
 805
 806     \param theVarName is a name of the variable.
 807 */
 808     string GetString( in string theVarName ) raises(StudyInvalidReference);
 809
 810
 811 /*! \brief Indicate if a variable is real
 812
 813     Return true if variable is real otherwise return false.
 814     \param theVarName is a name of the variable.
 815 */
 816     boolean IsReal( in string theVarName ) raises(StudyInvalidReference);
 817
 818 /*! \brief Indicate if a variable is integer
 819
 820     Return true if variable is integer otherwise return false.
 821     \param theVarName is a name of the variable.
 822 */
 823     boolean IsInteger( in string theVarName ) raises(StudyInvalidReference);
 824
 825 /*! \brief Indicate if a variable is boolean
 826
 827     Return true if variable is boolean otherwise return false.
 828     \param theVarName is a name of the variable.
 829 */
 830     boolean IsBoolean( in string theVarName ) raises(StudyInvalidReference);
 831
 832 /*! \brief Indicate if a variable is string
 833
 834     Return true if variable is string otherwise return false.
 835     \param theVarName is a name of the variable.
 836 */
 837     boolean IsString( in string theVarName ) raises(StudyInvalidReference);
 838
 839 /*! \brief Indicate if a variable exists in the study
 840
 841     Return true if variable exists in the study,
 842     otherwise return false.
 843     \param theVarName is a name of the variable.
 844 */
 845     boolean IsVariable( in string theVarName ) raises(StudyInvalidReference);
 846
 847 /*! \brief Get names of all variables from the study.
 848 */
 849     ListOfStrings GetVariableNames() raises(StudyInvalidReference);
 850
 851 /*! \brief Remove a variable
 852
 853    Remove variable with the specified name from the study with substitution of its value.
 854
 855    \param theVarName Name of the variable.
 856    \return Status of operation.
 857 */
 858     boolean RemoveVariable( in string theVarName ) raises(StudyInvalidReference);
 859
 860 /*! \brief Rename a variable
 861
 862    Rename variable with the specified name within the study.
 863
 864    \param theVarName Name of the variable.
 865    \param theNewVarName New name for the variable.
 866    \return Status of operation.
 867 */
 868     boolean RenameVariable( in string theVarName, in string theNewVarName ) raises(StudyInvalidReference);
 869
 870 /*! \brief Indicate whether variable is used
 871
 872    Check that variable is used in the study.
 873
 874    \param theVarName Name of the variable.
 875    \return Variable usage.
 876 */
 877     boolean IsVariableUsed( in string theVarName ) raises(StudyInvalidReference);
 878
 879 /*! \brief Parse variables used for object creation
 880
 881    \param string with variables, separated by special symbol.
 882    \return Variables list.
 883 */
 884     ListOfListOfStrings ParseVariables( in string theVars ) raises(StudyInvalidReference);
 885
 886 /*!
 887      Attach an observer to the Study
 888
 889     \param theObserver observer being attached
 890     \param modify when \c true, observer receives any object's modification events;
 891            otherwise observer receives object's creation events only
 892 */
 893      void attach(in SALOMEDS::Observer theObserver, in boolean modify);
 894 /*!
 895      Detach an observer from the Study
 896
 897     \param theObserver observer to be detached
 898 */
 899      void detach(in SALOMEDS::Observer theObserver);
 900   };
 901
 902   //==========================================================================
 903 /*! \brief %SObject interface
 904
 905    The objects in the %study are built by the %StudyBuilder. The %SObject interface
 906    provides methods for elementary inquiries, like getting an object %ID or its attribuites.
 907  \note
 908
 909    <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
 910    in the tree-type data structure.
 911    <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
 912    ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
 913 */
 914   //==========================================================================
 915
 916   interface SObject : SALOME::GenericObj
 917   {
 918 /*! Name of the %SObject
 919 */
 920     attribute string Name; // equivalent to setName() & getName()
 921
 922 /*! Returns true if the %SObject does not belong to any %Study
 923 */
 924     boolean IsNull();
 925
 926 /*! Gets an object %ID
 927    \return ID of the %SObject.
 928 */
 929     ID GetID();
 930
 931 /*!  Acquisition of the father %Component of the %SObject
 932   \return The father %Component of the %SObject.
 933 */
 934     SComponent GetFatherComponent();
 935
 936 /*! Acquisition of the father %SObject of the %SObject
 937    \return the father %SObject of the given %SObject.
 938 */
 939     SObject    GetFather();
 940
 941 /*! Gets the %tag of a %SObject
 942     \return the %tag of a %SObject.
 943 */
 944     short      Tag();
 945
 946 /*! Returns a tag of the last child %SObject (if any) of this %SObject.
 947     Returns zero if this %SObject has no children.
 948 */
 949     short      GetLastChildTag();
 950
 951 /*! Gets the depth of a %SObject
 952     \return the depth of a %SObject.
 953 */
 954     short      Depth();
 955
 956 /*! Looks for subobjects of a given %SObject.
 957     \param atag Tag of the given %SObject
 958     \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
 959 */
 960     boolean FindSubObject (in long atag, out SObject obj);
 961
 962 /*! Looks for attributes of a given %SObject
 963    \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
 964    \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
 965
 966 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
 967 */
 968     boolean FindAttribute(out GenericAttribute anAttribute,
 969                                   in  string         aTypeOfAttribute);
 970
 971 /*! Looks for a %SObject which the given %SObject refers to.
 972     \return The object which the given %SObject refers to as well as True if it finds
 973     this object.
 974 */
 975     boolean ReferencedObject(out SObject obj); // A REVOIR
 976
 977 /*! Gets all attributes of a given %SObject
 978     \return The list of all attributes of the given %SObject.
 979
 980 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 981
 982 */
 983     ListOfAttributes     GetAllAttributes();
 984
 985 /*! Gets the study of a given %SObject.
 986     \return The study containing the given %SObject.
 987 */
 988     Study GetStudy();
 989
 990 /*! Gets the CORBA object by its own IOR attribute.
 991     Returns nil, if can't.
 992     \return The CORBA object of the %SObject.
 993 */
 994     Object GetObject();
 995
 996 /*!
 997     Returns the name attribute value of this SObject.
 998     Returns empty string if there is no name attribute.
 999 */
1000     string GetName();
1001
1002 /*!
1003     Returns the comment attribute value of this SObject.
1004     Returns empty string if there is no comment attribute.
1005 */
1006     string GetComment();
1007
1008 /*!
1009     Returns the IOR attribute value of this SObject.
1010     Returns empty string if there is no IOR attribute.
1011 */
1012     string GetIOR();
1013
1014 /*!
1015     Set an attribute value (of type string)
1016    \param name the name of the attribute
1017    \param value the value of the attribute
1018 */
1019     void SetAttrString(in string name, in string value);
1020
1021 /*!
1022     Private method, returns an implementation of this SObject.
1023    \param theHostname is a hostname of the caller
1024    \param thePID is a process ID of the caller
1025    \param isLocal is set True if the SObject is launched locally with the caller
1026 */
1027     long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1028   };
1029
1030
1031   //==========================================================================
1032 /*! \brief %Generic attribute interface
1033
1034    %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
1035 */
1036   //==========================================================================
1037   interface GenericAttribute : SALOME::GenericObj
1038   {
1039 /*! \brief Exception locking all changes
1040
1041     This exception locks all modifications in attributes.
1042 */
1043     exception LockProtection {};
1044 /*! \brief Method CheckLocked
1045
1046    Checks whether the %Study is protected for modifications.
1047
1048    \note <BR>This exception is raised only outside a transaction.
1049 */
1050     void CheckLocked() raises (LockProtection);
1051
1052     //! Get Type
1053     string Type();
1054
1055     //! Get the class type
1056     string GetClassType();
1057
1058     //! Get SObject
1059     SObject GetSObject();
1060
1061   //!  Private method, returns an implementation of this GenericAttribute.
1062 /*!
1063    \param theHostname is a hostname of the caller
1064    \param thePID is a process ID of the caller
1065    \param isLocal is set True if the GenericAttribute is launched locally with the caller
1066 */
1067     long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1068   };
1069
1070
1071
1072   //==========================================================================
1073 /*! \brief %SComponent interface
1074
1075    The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
1076    The %SComponent interface is a specialization of the %SObject interface.
1077    It inherits the most of its methods from the %SObject interface.
1078 */
1079   //==========================================================================
1080   interface SComponent : SObject
1081   {
1082 /*! \brief Gets the data type of the given %SComponent
1083
1084     \return The data type of this %SComponent.
1085 */
1086     string  ComponentDataType();
1087 /*! \brief Gets the IOR of the given component
1088
1089   \return True (if there is an instance of the given component) and its IOR.
1090 */
1091     boolean ComponentIOR (out ID theID); //returns True if there is an instance
1092                                          //In this case ID identifies this one
1093   };
1094
1095
1096   //==========================================================================
1097 /*! \brief %SComponentIterator interface
1098
1099   This interface contains the methods allowing to iterate over all components in the list.
1100   The search is started from the first %SComponent in the list.
1101 */
1102   //==========================================================================
1103   interface SComponentIterator : SALOME::GenericObj
1104   {
1105 /*!
1106 \brief Activates the %SComponentIterator.
1107 */
1108     void Init();
1109 /*!  \brief Method More
1110
1111    \return True if there is one more %SComponent in the list.
1112 */
1113     boolean More();
1114 /*!
1115 \brief Moves the iterator to the next %SComponent in the list.
1116 */
1117     void Next();
1118 /*!
1119     \brief Returns the %SComponent corresponding to the current %SComponent found by the iterator.
1120
1121 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
1122
1123 */
1124     SComponent Value();
1125   };
1126
1127   //==========================================================================
1128 /*! \brief %ChildIterator interface
1129
1130     This interface contains methods which allow to iterate over all child
1131     levels.
1132 */
1133   //==========================================================================
1134   interface ChildIterator : SALOME::GenericObj
1135   {
1136 /*!
1137
1138 \brief Activates the %ChildIterator.
1139 */
1140     void Init();
1141 /*!
1142
1143 \brief Activates the %ChildIterator for all child levels.
1144
1145 \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
1146 */
1147     void InitEx(in boolean allLevels);
1148 /*! \brief Method More
1149
1150    \return True if there is one more %ChildIterator in the list.
1151 */
1152     boolean More();
1153 /*!
1154     \brief Passes the iterator to the next level.
1155 */
1156     void Next();
1157 /*!
1158     \brief Returns the %SObject corresponding to the current object found by the iterator.
1159 */
1160     SObject Value();
1161   };
1162
1163   //==========================================================================
1164   //==========================================================================
1165 /*! \brief Interface of the %UseCaseIterator.
1166
1167    This interface contains a set of methods used for iteration over the objects in the use case.
1168 */
1169   interface UseCaseIterator : SALOME::GenericObj
1170   {
1171 /*!
1172 Activates the %UseCaseIterator.
1173 \param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
1174 */
1175     void Init(in boolean allLevels);
1176 /*! Method More
1177
1178     \return True if the %UseCaseIterator finds one more object.
1179 */
1180     boolean More();
1181 /*!
1182     Passes the iterator to the next object.
1183 */
1184     void Next();
1185 /*!
1186     Returns the %SObject corresponding to the current object found by the Iterator.
1187 */
1188     SObject Value();
1189   };
1190
1191   //==========================================================================
1192   //==========================================================================
1193 /*! \brief Interface of the %UseCaseBuilder
1194
1195    Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1196    The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1197 */
1198   interface UseCaseBuilder : SALOME::GenericObj
1199   {
1200 /*!
1201    Adds to the use case an object as a child of the current object of the use case.
1202
1203    \param theObject The added %SObject.
1204    \return True if this %SObject has been added in the use case.
1205 */
1206     boolean Append(in SObject theObject);
1207 /*!
1208    Removes an object from the use case.
1209
1210    \param theObject The deleted %SObject
1211    \return True if this %SObject has been deleted from the use case.
1212 */
1213     boolean Remove(in SObject theObject);
1214 /*!
1215    Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1216 */
1217     boolean AppendTo(in SObject theFather, in SObject theObject);
1218 /*!
1219     Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1220 */
1221     boolean InsertBefore(in SObject theFirst, in SObject theNext);
1222 /*!
1223     Sets the current object of the use case.
1224 */
1225     boolean SetCurrentObject(in SObject theObject);
1226 /*!
1227     Makes the root object to be the current object of the use case.
1228 */
1229     boolean SetRootCurrent();
1230 /*!
1231    Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1232 */
1233     boolean HasChildren(in SObject theObject);
1234 /*!
1235    Returns True if children of the given object <VAR>theObject</VAR> of the use case tree were sorted successfully.
1236 */
1237     boolean SortChildren(in SObject theObject, in boolean theAscendingOrder);
1238 /*!
1239    Gets father object of the given object <VAR>theObject</VAR> in the use cases tree.
1240 */
1241     SObject GetFather(in SObject theObject);
1242 /*!
1243    Sets the name of the use case.
1244 */
1245     boolean SetName(in string theName);
1246 /*!
1247    Gets the name of the use case.
1248 */
1249     string GetName();
1250 /*!
1251    Returns True if the given object <VAR>theObject</VAR> represents a use case.
1252 */
1253     boolean IsUseCase(in SObject theObject);
1254 /*!
1255    Returns True if the given object <VAR>theObject</VAR> is included in the use cases tree on any level.
1256 */
1257     boolean IsUseCaseNode(in SObject theObject);
1258 /*!
1259     Gets the current object of the use case.
1260 */
1261     SObject GetCurrentObject();
1262 /*!
1263     Creates a new use case in the use case browser.
1264 */
1265     SObject AddUseCase(in string theName);
1266 /*!
1267     Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1268 */
1269     UseCaseIterator GetUseCaseIterator(in SObject theObject);
1270   };
1271   //==========================================================================
1272 /*! \brief %Driver interface
1273
1274 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
1275 can be called by any component and which provide the following functionality:
1276 <ul>
1277     <li> publishing in the study of the objects created by a definite component
1278     <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.
1279     <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
1280     <li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
1281 </ul>
1282
1283 */
1284   //==========================================================================
1285   interface Driver
1286   {
1287
1288     /*! \brief Saving the data produced by a definite component.
1289
1290         This method is called when saving a study.
1291        \param theComponent    %SComponent corresponding to this Component
1292        \param theURL  The path to the file in which the data will be saved.
1293        \param isMultiFile  If the value of this boolean parameter is True, the data will be saved in several files.
1294        \return A byte stream TMPFile that contains all saved data
1295
1296 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1297
1298      */
1299
1300
1301     TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1302
1303 /*! \brief Saving the data in ASCII format produced by a definite component.
1304
1305         This method is called when saving a study in ASCII format.
1306        \param theComponent    %SComponent corresponding to this Component
1307        \param theURL  The path to the file in which the data will be saved.
1308        \param isMultiFile  If the value of this boolean parameter is True, the data will be saved in several files.
1309        \return A byte stream TMPFile that will contain all saved data
1310
1311 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1312
1313      */
1314     TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1315
1316     /*! \brief Loading the data.
1317
1318        This method is called when opening a study.
1319        \param theComponent      %SComponent corresponding to this Component
1320        \param theStream   The file which contains all data saved by the component on Save method
1321        \param isMultiFile  If the value of this boolean parameter is True, the data will be loaded from several files
1322
1323      */
1324
1325     boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1326
1327     /*! \brief Loading the data from files in ASCII format.
1328
1329        This method is called when opening a study.
1330        \param theComponent      %SComponent corresponding to this Component
1331        \param theStream   The file which contains all data saved by the component on Save method
1332        \param isMultiFile  If the value of this boolean parameter is True, the data will be loaded from several files
1333
1334      */
1335
1336     boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1337
1338     /*! \brief Closing of the study
1339
1340       This method Close is called when closing a study.
1341     \param aSComponent The according %SComponent
1342      */
1343
1344     void Close (in SComponent aSComponent);
1345     //void Close ( in string  aIORSComponent);
1346
1347     /*! Gets the type of the data
1348
1349         \return The type of data produced by the Component in the study.
1350      */
1351
1352      string ComponentDataType();
1353
1354     // Driver Transient -> persistent called for each object in study
1355 /*!
1356    Transforms IOR of a given %SObject into PersistentID. It is called for each
1357    object in the %study.
1358 \note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
1359 study is saved these references are transformed into persintent IDs.
1360
1361    \param theSObject The given %SObject.
1362    \param IORString The IOR of the given %SObject.
1363    \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1364    \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1365
1366    \return The persistent ID of the given %SObject
1367
1368 */
1369     string IORToLocalPersistentID (in SObject theSObject,
1370                                    in string IORString,
1371                                    in boolean isMultiFile,
1372                                    in boolean isASCII);
1373 /*!
1374   Transforms PersistentID into IOR of the object. It is called for each
1375    object in the %study.
1376
1377    \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
1378 study is open, these references are transformed into persintent IORs.
1379
1380    \param theSObject The given %SObject.
1381    \param IORString The IOR of the given %SObject.
1382    \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1383    \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1384
1385    \return The IOR of the given %SObject
1386
1387 */
1388     string LocalPersistentIDToIOR (in SObject theSObject,
1389                                    in string aLocalPersistentID,
1390                                    in boolean isMultiFile,
1391                                    in boolean isASCII)
1392       raises (SALOME::SALOME_Exception);
1393
1394     // Publishing in the study
1395 /*! Publishing in the study
1396
1397     \return True if the given %Component can publish a definite object with a given IOR in the %study.
1398     \param theIOR The IOR of a definite object
1399 */
1400     boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1401 /*! \brief Publishing in the study
1402
1403    Publishes the given object in the %study, using the algorithm of this component.
1404     \param theSObject     If this parameter is null the object is published for the first time. Otherwise
1405     this parameter should contain a reference to the object published earlier
1406     \param theObject      The object which is published
1407     \param theName      The name of the published object. If this parameter is empty, the name is generated
1408     automatically by the component.
1409
1410     \return The published %SObject.
1411 */
1412     SObject PublishInStudy(in SObject theSObject, in Object theObject, in string theName);
1413
1414     // copy/paste methods
1415
1416 /*!
1417     Returns True, if the given %SObject can be copied to the clipboard.
1418
1419     \param theObject The given %SObject which should be copied.
1420 */
1421     boolean CanCopy(in SObject theObject);
1422 /*!
1423     Returns the object %ID and the %TMPFile of the object from the given %SObject.
1424 */
1425     TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1426 /*!
1427     Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1428 */
1429     boolean CanPaste(in string theComponentName, in long theObjectID);
1430 /*!
1431     Returns the %SObject of the pasted object.
1432 */
1433     SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);
1434
1435   };
1436 };
1437
1438 #endif