idl/SALOMEDS.idl

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