idl/SALOMEDS.idl

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