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 theID identifies a common parameters set (Example: "Interface Applicative")
 380     \param theModuleName is a name of the module (Example: "Geometry")
 381 */
 382     string GetDefaultScript(in string theID, in string theModuleName);
 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 %Study Builder Interface
 562
 563   The purpose of the Builder is to add and/or remove objects and attributes.
 564   A %StudyBuilder is linked to a %Study. A
 565   command management is provided for the undo/redo functionalities.
 566   \note
 567   <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
 568   item's position in the tree-type structure of the browser. In general it has the following
 569   form: <TT>0:2:1:1</TT>
 570 */
 571   //==========================================================================
 572
 573   interface StudyBuilder
 574   {
 575 /*! \brief %LockProtection Exception
 576
 577     This exception is raised while attempting to modify a locked %study.
 578 */
 579     exception LockProtection {};
 580 /*! \brief Creation of a new %SComponent.
 581
 582    Creates a new %SComponent
 583    \param ComponentDataType    Data type of the %SComponent which will be created.
 584
 585 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 586
 587 */
 588     SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
 589 /*! \brief Definition of the instance to the %SComponent
 590
 591     Defines the instance to the %SComponent.
 592 */
 593     void       DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
 594
 595 /*! \brief Deletion of a %SComponent
 596
 597   Removes a %SComponent.
 598 */
 599     void       RemoveComponent(in SComponent aComponent) raises(LockProtection);
 600
 601 /*! \brief Creation of a new %SObject
 602
 603    Creates a new %SObject under a definite father %SObject.
 604
 605    \param theFatherObject The father %SObject under which this one should be created.
 606    \return New %SObject
 607
 608 <em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
 609
 610 */
 611
 612     SObject NewObject      (in SObject theFatherObject) raises(LockProtection);
 613
 614 /*! \brief Creation of a new %SObject with a definite %tag
 615
 616    Creates a new %SObject with a definite %tag.
 617
 618    \param atag Long value corresponding to the tag of the new %SObject.
 619    \return New %SObject
 620
 621 */
 622     SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
 623 /*! \brief Deletion of the %SObject
 624
 625   Removes a %SObject from the %StudyBuilder.
 626
 627   \param anObject The %SObject to be deleted.
 628 */
 629     void    RemoveObject   (in SObject anObject) raises(LockProtection);
 630 /*! \brief Deletion of the %SObject with all his child objects.
 631
 632   Removes the %SObject with all his child objects.
 633
 634   \param anObject The %SObject to be deleted with all child objects.
 635 */
 636     void    RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
 637
 638 /*!
 639    Loads a %SComponent.
 640
 641 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
 642
 643 */
 644     void  LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
 645 /*!
 646    Loads a %SObject.
 647
 648    \param sco %SObject to be loaded.
 649 */
 650     void  Load (in SObject sco);
 651
 652 /*! \brief Looking for or creating an attribute assigned to the %SObject
 653
 654     Allows to find or create an attribute of a specific type which is assigned to the object.
 655     \param anObject        The %SObject corresponding to the attribute which is looked for.
 656     \param aTypeOfAttribute     Type of the attribute.
 657
 658 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
 659 */
 660
 661     GenericAttribute FindOrCreateAttribute(in  SObject        anObject,
 662                                          in  string         aTypeOfAttribute) raises(LockProtection);
 663
 664 /*! \brief Looking for an attribute assigned to a %SObject
 665
 666     Allows to find an attribute of a specific type which is assigned to the object.
 667     \param anObject        The %SObject corresponding to the attribute which is looked for.
 668     \param aTypeOfAttribute     Type of the attribute.
 669     \param anAttribute       Where the attribute is placed if it's found.
 670     \return True if it finds an attribute.
 671  */
 672
 673     boolean FindAttribute(in  SObject        anObject,
 674                                  out GenericAttribute anAttribute,
 675                                  in  string         aTypeOfAttribute);
 676 /*! \brief Deleting the attribute assigned to the %SObject
 677
 678     Removes the attribute of a specific type which is assigned to the object.
 679     \param anObject        The %SObject corresponding to the attribute.
 680     \param aTypeOfAttribute     Type of the attribute.
 681
 682 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 683 */
 684     void RemoveAttribute(in  SObject        anObject,
 685                          in  string         aTypeOfAttribute) raises(LockProtection);
 686 /*!
 687     Adds a reference between %anObject and %theReferencedObject.
 688     \param anObject The %SObject which will get a reference
 689     \param theReferencedObject The %SObject having a reference
 690 */
 691
 692     void Addreference(in SObject anObject,
 693                       in SObject theReferencedObject) ;
 694
 695 /*!
 696     Removes a reference from %anObject to another object.
 697     \param anObject The %SObject which contains a reference
 698 */
 699
 700     void RemoveReference(in SObject anObject) ;
 701
 702 /*!
 703    Adds a directory in the %Study.
 704    \param theName String parameter defining the name of the directory.
 705
 706 <em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
 707
 708 */
 709     void AddDirectory(in string theName) raises(LockProtection);
 710
 711 /*! \brief Identification of the %SObject's substructure.
 712
 713       Identification of the %SObject's substructure by GUID.
 714
 715
 716       \param anObject The %SObject which will be identified
 717       \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
 718 */
 719
 720      void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
 721 /*!
 722 Searches for a definite %SObject with a definite GUID and returns True if it finds it.
 723
 724 \param anObject A definite %SObject which will be identified
 725 \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
 726 */
 727      boolean IsGUID(in SObject anObject, in string theGUID);
 728
 729 /*! \brief Creation of a new command
 730
 731    Creates a new command which can contain several different actions.
 732
 733 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
 734
 735 */
 736     void NewCommand(); // command management
 737 /*! \brief Execution of the command
 738
 739    Commits all actions declared within this command.
 740
 741    \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
 742
 743 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 744
 745 */
 746     void CommitCommand() raises(LockProtection); // command management
 747 /*!
 748     Returns True if at this moment there is a command under execution.
 749 */
 750     boolean HasOpenCommand();
 751 /*! \brief Cancelation of the command
 752
 753     Cancels all actions declared within the command.
 754
 755 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 756 */
 757     void AbortCommand(); // command management
 758 /*! \brief Undolimit
 759
 760     The number of actions which can be undone
 761 */
 762     attribute long  UndoLimit;
 763 /*! \brief Undo method
 764
 765     Cancels all actions of the last command.
 766
 767     \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
 768
 769 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 770
 771 */
 772     void Undo() raises (LockProtection);
 773 /*! \brief Redo method
 774
 775     Redoes all actions of the last command.
 776
 777 \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
 778
 779 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 780
 781 */
 782     void Redo() raises (LockProtection);
 783 /*!
 784     Returns True if at this moment there are any actions which can be canceled.
 785
 786 <em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
 787
 788 */
 789     boolean GetAvailableUndos();
 790 /*!
 791     Returns True if at this moment there are any actions which can be redone.
 792
 793 <em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
 794
 795 */
 796     boolean GetAvailableRedos();
 797 /*!
 798     Puts name attribute with the given string value to the given %SObject
 799
 800     \param theSO Existing SObject to set name attribute.
 801     \param theValue The value to be set to the name attribute.
 802 */
 803     void SetName(in SObject theSO, in string theValue) raises (LockProtection);
 804
 805 /*!
 806     Puts comment attribute with the given string value to the given %SObject
 807
 808     \param theSO Existing SObject to set comment attribute.
 809     \param theValue The value to be set to the comment attribute.
 810 */
 811     void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
 812
 813 /*!
 814     Puts IOR attribute with the given string value to the given %SObject
 815
 816     \param theSO Existing SObject to set IOR attribute.
 817     \param theValue The value to be set to the IOR attribute.
 818 */
 819     void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
 820   };
 821
 822   //==========================================================================
 823 /*! \brief %Study Manager interface
 824
 825     The purpose of the Manager is to manipulate the %Studies. You will find in this
 826     interface the methods to create, open,
 827     close, and save a %Study. Since a %SALOME session is multi-document, you will
 828     also find the methods allowing to navigate
 829     through the collection of studies present in a session.
 830 */
 831   //==========================================================================
 832
 833   interface StudyManager
 834   {
 835 /*!
 836     Determines whether the server has already been loaded or not.
 837 */
 838     void ping();
 839
 840     void Shutdown();
 841
 842 /*!
 843     Returns the PID of the server
 844 */
 845     long getPID();
 846
 847 /*!
 848     Shutdown the StudyManager process.
 849 */
 850     oneway void ShutdownWithExit();
 851
 852 /*! \brief Creation of a new study
 853
 854      Creates a new study with a definite name.
 855
 856      \param study_name String parameter defining the name of the study
 857
 858 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
 859
 860 */
 861     Study NewStudy(in string study_name);
 862
 863 /*! \brief Open a study
 864
 865      Reads and activates the structure of the study %Objects.
 866      \param aStudyUrl The path to the study
 867     \warning This method doesn't activate the corba objects. Only a component can do it.
 868
 869 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
 870 */
 871     Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
 872
 873 /*! \brief Closing the study
 874
 875     Closes a study.
 876 */
 877     void  Close(in Study aStudy);
 878 /*! \brief Saving the study in a HDF file (or files).
 879
 880     Saves a study.
 881
 882     \param theMultiFile If this parameter is True the study will be saved in several files.
 883
 884 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
 885
 886 */
 887     boolean  Save(in  Study aStudy, in boolean theMultiFile);
 888 /*! \brief Saving a study in a ASCII file (or files).
 889
 890     Saves a study in an ASCII format file (or files).
 891     \param theMultiFile If this parameter is True the study will be saved in several files.
 892 */
 893     boolean  SaveASCII(in  Study aStudy, in boolean theMultiFile);
 894 /*! \brief Saving the study in a specified HDF file (or files).
 895
 896     Saves the study in a specified file (or files).
 897     \param aUrl The path to the definite file in whcih the study will be saved
 898     \param aStudy The study which will be saved
 899     \param theMultiFile If this parameter is True the study will be saved in several files.
 900
 901 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
 902 */
 903     boolean  SaveAs(in URL   aUrl, // if the file already exists
 904                 in Study aStudy,
 905                 in boolean theMultiFile); // overwrite (as option)
 906 /*! \brief Saving the study in a specified ASCII file (or files).
 907
 908     Saves the study in a specified ASCII file (or files).
 909
 910     \param aUrl The path to the definite file in whcih the study will be saved
 911     \param aStudy The study which will be saved
 912     \param theMultiFile If this parameter is True the study will be saved in several files.
 913 */
 914     boolean  SaveAsASCII(in URL   aUrl, // if the file already exists
 915                       in Study aStudy,
 916                       in boolean theMultiFile); // overwrite (as option)
 917
 918
 919 /*! \brief List of open studies.
 920
 921 Gets the list of open studies
 922
 923     \return A list of open studies in the current session.
 924 */
 925     ListOfOpenStudies GetOpenStudies();
 926
 927 /*! \brief Getting a particular %Study picked by name
 928
 929     Activates a particular %Study
 930     among the session collection picking it by name.
 931     \param aStudyName The name of the study
 932 */
 933     Study GetStudyByName  (in string aStudyName);
 934
 935 /*! \brief Getting a particular %Study picked by ID
 936
 937     Activates a particular %Study
 938     among the session collection picking it by ID.
 939     \param aStudyID The ID of the study
 940 */
 941     Study GetStudyByID  (in short aStudyID);
 942
 943     // copy/paste methods
 944
 945 /*!
 946     Returns True, if the given %SObject can be copied to the clipboard.
 947 */
 948     boolean CanCopy(in SObject theObject);
 949 /*!
 950     Returns True, if the given %SObject is copied to the clipboard.
 951     \param theObject The %SObject which will be copied
 952 */
 953     boolean Copy(in SObject theObject);
 954 /*!
 955     Returns True, if the object from the clipboard can be pasted to the given %SObject.
 956     \param theObject The %SObject stored in the clipboard.
 957 */
 958     boolean CanPaste(in SObject theObject);
 959 /*!
 960     Returns the %SObject in which the object from the clipboard was pasted to.
 961     \param theObject The %SObject which will be pasted
 962     \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
 963     an object into a study, which is protected for modifications.
 964 */
 965     SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
 966
 967 /*! \brief Object conversion.
 968
 969     Converts an object into IOR.
 970     \return    IOR
 971 */
 972     string ConvertObjectToIOR(in Object theObject);
 973 /*! \brief Object conversion.
 974
 975     Converts IOR into an object.
 976     \return    An object
 977 */
 978     Object ConvertIORToObject(in string theIOR);
 979
 980 /*!
 981     Private method, returns an implementation of this StudyManager.
 982    \param theHostname is a hostname of the caller
 983    \param thePID is a process ID of the caller
 984    \param isLocal is set True if the StudyManager is launched locally with the caller
 985 */
 986     long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
 987
 988
 989   };
 990
 991
 992   //==========================================================================
 993 /*! \brief %SObject interface
 994
 995    The objects in the %study are built by the %StudyBuilder. The %SObject interface
 996    provides methods for elementary inquiries, like getting an object %ID or its attribuites.
 997  \note
 998
 999    <BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
1000    in the tree-type data structure.
1001    <BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
1002    ID is a list of tags and it has the following form: <TT>0:2:1:1</TT>.
1003 */
1004   //==========================================================================
1005
1006   interface SObject : SALOME::GenericObj
1007   {
1008 /*! Name of the %SObject
1009 */
1010     attribute string Name; // equivalent to setName() & getName()
1011
1012 /*! Returns true if the %SObject does not belong to any %Study
1013 */
1014     boolean IsNull();
1015
1016 /*! Gets an object %ID
1017
1018    \return ID of the %SObject.
1019 */
1020     ID GetID();
1021 /*!  Acquisition of the father %Component of the %SObject
1022
1023   \return The father %Component of the %SObject.
1024 */
1025     SComponent GetFatherComponent();
1026 /*! Acquisition of the father %SObject of the %SObject
1027
1028    \return the father %SObject of the given %SObject.
1029 */
1030     SObject    GetFather();
1031 /*! Gets the %tag of a %SObject
1032
1033     \return the %tag of a %SObject.
1034 */
1035     short      Tag();
1036 /*! Gets the depth of a %SObject
1037
1038     \return the depth of a %SObject.
1039 */
1040     short      Depth();
1041 /*! Looks for subobjects of a given %SObject.
1042
1043     \param atag Tag of the given %SObject
1044     \return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
1045 */
1046
1047     boolean FindSubObject (in long atag, out SObject obj);
1048 /*! Looks for attributes of a given %SObject
1049
1050    \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
1051    \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
1052
1053 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
1054 */
1055     boolean FindAttribute(out GenericAttribute anAttribute,
1056                                   in  string         aTypeOfAttribute);
1057 /*! Looks for a %SObject which the given %SObject refers to.
1058
1059     \return The object which the given %SObject refers to as well as True if it finds
1060     this object.
1061 */
1062     boolean ReferencedObject(out SObject obj); // A REVOIR
1063 /*! Gets all attributes of a given %SObject
1064
1065     \return The list of all attributes of the given %SObject.
1066
1067 <em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
1068
1069 */
1070     ListOfAttributes     GetAllAttributes();
1071 /*! Gets the study of a given %SObject.
1072
1073     \return The study containing the given %SObject.
1074 */
1075     Study GetStudy();
1076
1077 /*! Gets the CORBA object by its own IOR attribute.
1078     Returns nil, if can't.
1079
1080     \return The CORBA object of the %SObject.
1081 */
1082     Object GetObject();
1083
1084 /*!
1085     Returns the name attribute value of this SObject.
1086     Returns empty string if there is no name attribute.
1087 */
1088     string GetName();
1089
1090 /*!
1091     Returns the comment attribute value of this SObject.
1092     Returns empty string if there is no comment attribute.
1093 */
1094     string GetComment();
1095
1096 /*!
1097     Returns the IOR attribute value of this SObject.
1098     Returns empty string if there is no IOR attribute.
1099 */
1100     string GetIOR();
1101
1102 /*!
1103     Set an attribute value (of type string)
1104    \param name the name of the attribute
1105    \param value the value of the attribute
1106 */
1107     void SetAttrString(in string name, in string value);
1108
1109 /*!
1110     Private method, returns an implementation of this SObject.
1111    \param theHostname is a hostname of the caller
1112    \param thePID is a process ID of the caller
1113    \param isLocal is set True if the SObject is launched locally with the caller
1114 */
1115     long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1116   };
1117
1118
1119   //==========================================================================
1120 /*! \brief %Generic attribute interface
1121
1122    %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study.
1123 */
1124   //==========================================================================
1125   interface GenericAttribute : SALOME::GenericObj
1126   {
1127 /*! \brief Exception locking all changes
1128
1129     This exception locks all modifications in attributes.
1130 */
1131     exception LockProtection {};
1132 /*! \brief Method CheckLocked
1133
1134    Checks whether the %Study is protected for modifications.
1135
1136    \note <BR>This exception is raised only outside a transaction.
1137 */
1138     void CheckLocked() raises (LockProtection);
1139
1140     //! Get Type
1141     string Type();
1142
1143     //! Get the class type
1144     string GetClassType();
1145
1146     //! Get SObject
1147     SObject GetSObject();
1148
1149   //!  Private method, returns an implementation of this GenericAttribute.
1150 /*!
1151    \param theHostname is a hostname of the caller
1152    \param thePID is a process ID of the caller
1153    \param isLocal is set True if the GenericAttribute is launched locally with the caller
1154 */
1155     long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
1156   };
1157
1158
1159
1160   //==========================================================================
1161 /*! \brief %SComponent interface
1162
1163    The %SComponent interface establishes in the study a permanent assocition to the Components integrated into %SALOME platform.
1164    The %SComponent interface is a specialization of the %SObject interface.
1165    It inherits the most of its methods from the %SObject interface.
1166 */
1167   //==========================================================================
1168   interface SComponent : SObject
1169   {
1170 /*! \brief Gets the data type of the given %SComponent
1171
1172     \return The data type of this %SComponent.
1173 */
1174     string  ComponentDataType();
1175 /*! \brief Gets the IOR of the given component
1176
1177   \return True (if there is an instance of the given component) and its IOR.
1178 */
1179     boolean ComponentIOR (out ID theID); //returns True if there is an instance
1180                                          //In this case ID identifies this one
1181   };
1182
1183
1184   //==========================================================================
1185 /*! \brief %SComponentIterator interface
1186
1187   This interface contains the methods allowing to iterate over all components in the list.
1188   The search is started from the first %SComponent in the list.
1189 */
1190   //==========================================================================
1191   interface SComponentIterator : SALOME::GenericObj
1192   {
1193 /*!
1194 \brief Activates the %SComponentIterator.
1195 */
1196     void Init();
1197 /*!  \brief Method More
1198
1199    \return True if there is one more %SComponent in the list.
1200 */
1201     boolean More();
1202 /*!
1203 \brief Moves the iterator to the next %SComponent in the list.
1204 */
1205     void Next();
1206 /*!
1207     \brief Returns the %SComponent corresponding to the current %SComponent found by the iterator.
1208
1209 <em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
1210
1211 */
1212     SComponent Value();
1213   };
1214
1215   //==========================================================================
1216 /*! \brief %ChildIterator interface
1217
1218     This interface contains methods which allow to iterate over all child
1219     levels.
1220 */
1221   //==========================================================================
1222   interface ChildIterator : SALOME::GenericObj
1223   {
1224 /*!
1225
1226 \brief Activates the %ChildIterator.
1227 */
1228     void Init();
1229 /*!
1230
1231 \brief Activates the %ChildIterator for all child levels.
1232
1233 \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels.
1234 */
1235     void InitEx(in boolean allLevels);
1236 /*! \brief Method More
1237
1238    \return True if there is one more %ChildIterator in the list.
1239 */
1240     boolean More();
1241 /*!
1242     \brief Passes the iterator to the next level.
1243 */
1244     void Next();
1245 /*!
1246     \brief Returns the %SObject corresponding to the current object found by the iterator.
1247 */
1248     SObject Value();
1249   };
1250
1251   //==========================================================================
1252   //==========================================================================
1253 /*! \brief Interface of the %UseCaseIterator.
1254
1255    This interface contains a set of methods used for iteration over the objects in the use case.
1256 */
1257   interface UseCaseIterator : SALOME::GenericObj
1258   {
1259 /*!
1260 Activates the %UseCaseIterator.
1261 \param allLevels If the value of this parameter is True the Iterator is activated for all subobjects.
1262 */
1263     void Init(in boolean allLevels);
1264 /*! Method More
1265
1266     \return True if the %UseCaseIterator finds one more object.
1267 */
1268     boolean More();
1269 /*!
1270     Passes the iterator to the next object.
1271 */
1272     void Next();
1273 /*!
1274     Returns the %SObject corresponding to the current object found by the Iterator.
1275 */
1276     SObject Value();
1277   };
1278
1279   //==========================================================================
1280   //==========================================================================
1281 /*! \brief Interface of the %UseCaseBuilder
1282
1283    Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study.
1284    The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study.
1285 */
1286   interface UseCaseBuilder : SALOME::GenericObj
1287   {
1288 /*!
1289    Adds to the use case an object as a child of the current object of the use case.
1290
1291    \param theObject The added %SObject.
1292    \return True if this %SObject has been added in the use case.
1293 */
1294     boolean Append(in SObject theObject);
1295 /*!
1296    Removes an object from the use case.
1297
1298    \param theObject The deleted %SObject
1299    \return True if this %SObject has been deleted from the use case.
1300 */
1301     boolean Remove(in SObject theObject);
1302 /*!
1303    Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
1304 */
1305     boolean AppendTo(in SObject theFather, in SObject theObject);
1306 /*!
1307     Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
1308 */
1309     boolean InsertBefore(in SObject theFirst, in SObject theNext);
1310 /*!
1311     Sets the current object of the use case.
1312 */
1313     boolean SetCurrentObject(in SObject theObject);
1314 /*!
1315     Makes the root object to be the current object of the use case.
1316 */
1317     boolean SetRootCurrent();
1318 /*!
1319    Returns True if the given object <VAR>theObject</VAR> of the use case has child objects.
1320 */
1321     boolean HasChildren(in SObject theObject);
1322 /*!
1323    Returns True if children of the given object <VAR>theObject</VAR> of the use case tree were sorted successfully.
1324 */
1325     boolean SortChildren(in SObject theObject, in boolean theAscendingOrder);
1326 /*!
1327    Gets father object of the given object <VAR>theObject</VAR> in the use cases tree.
1328 */
1329     SObject GetFather(in SObject theObject);
1330 /*!
1331    Sets the name of the use case.
1332 */
1333     boolean SetName(in string theName);
1334 /*!
1335    Gets the name of the use case.
1336 */
1337     string GetName();
1338 /*!
1339    Returns True if the given object <VAR>theObject</VAR> represents a use case.
1340 */
1341     boolean IsUseCase(in SObject theObject);
1342 /*!
1343    Returns True if the given object <VAR>theObject</VAR> is included in the use cases tree on any level.
1344 */
1345     boolean IsUseCaseNode(in SObject theObject);
1346 /*!
1347     Gets the current object of the use case.
1348 */
1349     SObject GetCurrentObject();
1350 /*!
1351     Creates a new use case in the use case browser.
1352 */
1353     SObject AddUseCase(in string theName);
1354 /*!
1355     Returns the %UseCaseIterator for the given object <VAR>theObject</VAR> in the use case.
1356 */
1357     UseCaseIterator GetUseCaseIterator(in SObject theObject);
1358   };
1359   //==========================================================================
1360 /*! \brief %Driver interface
1361
1362 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
1363 can be called by any component and which provide the following functionality:
1364 <ul>
1365     <li> publishing in the study of the objects created by a definite component
1366     <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.
1367     <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
1368     <li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
1369 </ul>
1370
1371 */
1372   //==========================================================================
1373   interface Driver
1374   {
1375
1376     /*! \brief Saving the data produced by a definite component.
1377
1378         This method is called by the StudyManager when saving a study.
1379        \param theComponent    %SComponent corresponding to this Component
1380        \param theURL  The path to the file in which the data will be saved.
1381        \param isMultiFile  If the value of this boolean parameter is True, the data will be saved in several files.
1382        \return A byte stream TMPFile that contains all saved data
1383
1384 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1385
1386      */
1387
1388
1389     TMPFile Save(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1390
1391 /*! \brief Saving the data in ASCII format produced by a definite component.
1392
1393         This method is called by the StudyManager when saving a study in ASCII format.
1394        \param theComponent    %SComponent corresponding to this Component
1395        \param theURL  The path to the file in which the data will be saved.
1396        \param isMultiFile  If the value of this boolean parameter is True, the data will be saved in several files.
1397        \return A byte stream TMPFile that will contain all saved data
1398
1399 <em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
1400
1401      */
1402     TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);
1403
1404     /*! \brief Loading the data.
1405
1406        This method is called by the StudyManager when opening a study.
1407        \param theComponent      %SComponent corresponding to this Component
1408        \param theStream   The file which contains all data saved by the component on Save method
1409        \param isMultiFile  If the value of this boolean parameter is True, the data will be loaded from several files
1410
1411      */
1412
1413     boolean Load(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1414
1415     /*! \brief Loading the data from files in ASCII format.
1416
1417        This method is called by the StudyManager when opening a study.
1418        \param theComponent      %SComponent corresponding to this Component
1419        \param theStream   The file which contains all data saved by the component on Save method
1420        \param isMultiFile  If the value of this boolean parameter is True, the data will be loaded from several files
1421
1422      */
1423
1424     boolean LoadASCII(in SComponent theComponent, in TMPFile theStream, in string theURL, in boolean isMultiFile);
1425
1426     /*! \brief Closing of the study
1427
1428       This method Close is called by the StudyManager when closing a study.
1429     \param aSComponent The according %SComponent
1430      */
1431
1432     void Close (in SComponent aSComponent);
1433     //void Close ( in string  aIORSComponent);
1434
1435     /*! Gets the type of the data
1436
1437         \return The type of data produced by the Component in the study.
1438      */
1439
1440      string ComponentDataType();
1441
1442     // Driver Transient -> persistent called for each object in study
1443 /*!
1444    Transforms IOR of a given %SObject into PersistentID. It is called for each
1445    object in the %study.
1446 \note <br> In %SALOME the objects which are present in an active study are identified by an IOR, when this
1447 study is saved these references are transformed into persintent IDs.
1448
1449    \param theSObject The given %SObject.
1450    \param IORString The IOR of the given %SObject.
1451    \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1452    \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1453
1454    \return The persistent ID of the given %SObject
1455
1456 */
1457     string IORToLocalPersistentID (in SObject theSObject,
1458                                    in string IORString,
1459                                    in boolean isMultiFile,
1460                                    in boolean isASCII);
1461 /*!
1462   Transforms PersistentID into IOR of the object. It is called for each
1463    object in the %study.
1464
1465    \note <br> In %SALOME the objects which are present in an saved study (file) are identified by a persistent ID, when this
1466 study is open, these references are transformed into persintent IORs.
1467
1468    \param theSObject The given %SObject.
1469    \param IORString The IOR of the given %SObject.
1470    \param isMultiFile If this parameter is True the study containing the given %SObject is stored in several files.
1471    \param isASCII If this parameter is True the study containing the given %SObject is stored in ASCII format.
1472
1473    \return The IOR of the given %SObject
1474
1475 */
1476     string LocalPersistentIDToIOR (in SObject theSObject,
1477                                    in string aLocalPersistentID,
1478                                    in boolean isMultiFile,
1479                                    in boolean isASCII)
1480       raises (SALOME::SALOME_Exception);
1481
1482     // Publishing in the study
1483 /*! Publishing in the study
1484
1485     \return True if the given %Component can publish a definite object with a given IOR in the %study.
1486     \param theIOR The IOR of a definite object
1487 */
1488     boolean CanPublishInStudy(in Object theIOR) raises (SALOME::SALOME_Exception);
1489 /*! \brief Publishing in the study
1490
1491    Publishes the given object in the %study, using the algorithm of this component.
1492     \param theStudy     The %study in which the object is published
1493     \param theSObject     If this parameter is null the object is published for the first time. Otherwise
1494     this parameter should contain a reference to the object published earlier
1495     \param theObject      The object which is published
1496     \param theName      The name of the published object. If this parameter is empty, the name is generated
1497     automatically by the component.
1498
1499     \return The published %SObject.
1500 */
1501     SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
1502
1503     // copy/paste methods
1504
1505 /*!
1506     Returns True, if the given %SObject can be copied to the clipboard.
1507
1508     \param theObject The given %SObject which should be copied.
1509 */
1510     boolean CanCopy(in SObject theObject);
1511 /*!
1512     Returns the object %ID and the %TMPFile of the object from the given %SObject.
1513 */
1514     TMPFile CopyFrom(in SObject theObject, out long theObjectID);
1515 /*!
1516     Returns True, if the component can paste the object with given %ID of the component with name <VAR>theComponentName</VAR>.
1517 */
1518     boolean CanPaste(in string theComponentName, in long theObjectID);
1519 /*!
1520     Returns the %SObject of the pasted object.
1521 */
1522     SObject PasteInto(in TMPFile theStream, in long theObjectID, in SObject theObject);
1523
1524   };
1525 };
1526
1527 #endif