X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=idl%2FSALOMEDS.idl;h=c6a709bcf1514e6dca3945c1a038df245f0e4a71;hb=f9ce15cb3b95e2156c0b967ec70b69ba1d864a2f;hp=eb14c2fa06516d9e39bbef8b5e82b59354aa745d;hpb=3e8cb819ece8ab264fe0c8d6d970387d2bfeb755;p=modules%2Fkernel.git diff --git a/idl/SALOMEDS.idl b/idl/SALOMEDS.idl index eb14c2fa0..c6a709bcf 100644 --- a/idl/SALOMEDS.idl +++ b/idl/SALOMEDS.idl @@ -1,4 +1,4 @@ -// Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE +// Copyright (C) 2007-2021 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 @@ -280,7 +280,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin Returns True if at this moment there is a command under execution. */ boolean HasOpenCommand(); -/*! \brief Cancelation of the command +/*! \brief Cancellation of the command Cancels all actions declared within the command. @@ -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 theObject to the given father theFather 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 theFirst before the object theNext. */ @@ -1216,7 +1231,7 @@ can be called by any component and which provide the following functionality: