Salome HOME
#19007 [CEA][Windows] SALOME non regression tests on Windows: fix KERNEL_SALOME_COMMA...
[modules/kernel.git] / idl / SALOMEDS.idl
index e063ff7adf541b4c2e03cdc681320b930cede778..b6c4dcf2b47936ba97f254cac3ee8c60bc38fa4c 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -384,7 +384,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin
     exception StudyNameError {};
 //! Invalid study comment
     exception StudyCommentError {};
-    
+
 /*!
     Determines whether the server has already been loaded or not.
 */
@@ -558,7 +558,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin
 /*! \brief Get a new %UseCaseBuilder.
 */
     UseCaseBuilder  GetUseCaseBuilder() raises(StudyInvalidReference);
-    
+
 /*! \brief Clear a study object
 */
     void Clear() raises(StudyInvalidReference);
@@ -566,14 +566,21 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin
 /*! \brief Initialization a study object
 */
     void Init() raises(StudyInvalidReference);
-    
+
 /*! \brief Open a study by url
 
     Reads and activates the structure of the study %Objects.
     \param aStudyUrl The path to the study
 */
     boolean Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception);
-    
+
+/*! \brief Check if study can be opened
+
+    Tries to open and read given url.
+    \param aStudyUrl The path to the study
+*/
+    boolean CanOpen (in URLPath aStudyUrl);
+
 /*! \brief Saving the study in a file (or files).
 
     Saves a study.
@@ -581,11 +588,11 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin
     \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
 */
     boolean Save(in boolean theMultiFile, in boolean theASCII) raises(StudyInvalidReference);
-    
+
 /*! \brief Saving the study in a specified file (or files).
 
     Saves the study in a specified file (or files).
-    \param aUrl The path to the definite file in whcih the study will be saved
+    \param aUrl The path to the definite file in which the study will be saved
     \param theMultiFile If this parameter is True the study will be saved in several files.
     \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
 
@@ -593,8 +600,8 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin
 */
     boolean  SaveAs(in URLPath aUrl, // if the file already exists
                     in boolean theMultiFile, // overwrite (as option)
-                    in boolean theASCII) 
-                    raises(StudyInvalidReference); 
+                    in boolean theASCII)
+                    raises(StudyInvalidReference);
 /*!
     Returns True, if the given %SObject can be copied to the clipboard.
 */
@@ -637,6 +644,10 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin
                       in boolean isPublished,
                       in boolean isMultiFile) raises(StudyInvalidReference);
 
+/*! \brief  Returns the folder of the python script which is currently dumped.
+*/
+    string GetDumpPath();
+
 /*! \brief  Get an AttributeParameter used to store common parameters for given %theSavePoint.
 
     \param theID identifies a common parameters set (Example: "Interface Applicative")
@@ -1155,6 +1166,10 @@ Activates the %UseCaseIterator.
    Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
 */
     boolean AppendTo(in SObject theFather, in SObject theObject);
+/*!
+    Return index of a child among father children
+*/
+    long GetIndexInFather(in SObject theFather, in SObject theObject);
 /*!
     Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
 */