X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=idl%2FSALOMEDS.idl;h=b6c4dcf2b47936ba97f254cac3ee8c60bc38fa4c;hb=cca842065fd2bb93bae7ed6c32a7de16b06f94d9;hp=bc22b3d339437d8859e606cefd945c9eadf4b7d1;hpb=b7e1322de9ff9e2947d1a914d4bc20c2cb395cb5;p=modules%2Fkernel.git diff --git a/idl/SALOMEDS.idl b/idl/SALOMEDS.idl index bc22b3d33..b6c4dcf2b 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-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 @@ -41,7 +41,7 @@ module SALOMEDS { /*! \brief Name of the file in which the %Study is saved. */ - typedef string URLPath; + typedef wstring URLPath; /*! \brief Main identifier of an object in %SALOME application */ @@ -55,6 +55,8 @@ module SALOMEDS */ typedef string SalomeReference; +//! List of file names + typedef sequence ListOfFileNames; //! List of modification dates of a study typedef sequence ListOfDates ; //! An unbounded sequence of strings @@ -125,6 +127,7 @@ module SALOMEDS */ SComponent NewComponent(in string ComponentDataType) raises(LockProtection); + /*! \brief Definition of the instance to the %SComponent Defines the instance to the %SComponent. @@ -246,8 +249,7 @@ module SALOMEDS \param anObject The %SObject which will be identified \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000" */ - - void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection); + void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection); /*! Searches for a definite %SObject with a definite GUID and returns True if it finds it. @@ -278,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. @@ -382,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. */ @@ -402,7 +404,10 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin This is equivalent to the methods setName() & getName() */ - readonly attribute string Name; // equivalent to getName() + attribute wstring Name; // equivalent to getName() + +/*! \brief Indicate the file where the %study has been saved +*/ //! Sequence containing %SObjects typedef sequence ListOfSObject; @@ -518,7 +523,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin /*! \brief Indicate the file where the %study has been saved */ - attribute string URL; + attribute wstring URL; /*! \brief List of %SObjects @@ -553,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); @@ -561,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. @@ -576,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. @@ -588,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. */ @@ -632,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") @@ -1150,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. */ @@ -1211,7 +1231,7 @@ can be called by any component and which provide the following functionality:
  • publishing in the study of the objects created by a definite component
  • saving/loading of the data created by a definite component. These methods are called when loading/saving a study containing the data created by a definite component. -
  • transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study +
  • transforming of the transient references into persistent references (or vice versa) of the SObjects when saving (or loading) a study
  • copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study