idl/SALOMEDS.idl

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